ManiVault 1.0.0
A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data
Loading...
Searching...
No Matches
Clusters Class Reference

#include <ClusterData.h>

Inheritance diagram for Clusters:
hdps::DatasetImpl hdps::gui::WidgetAction hdps::util::Serializable

Public Member Functions

 Clusters (CoreInterface *core, QString dataName, const QString &guid="")
 
 ~Clusters () override
 
void init () override
 
QVector< Cluster > & getClusters ()
 
const QVector< Cluster > & getClusters () const
 
void addCluster (Cluster &cluster)
 
void removeClusterById (const QString &id)
 
void removeClustersById (const QStringList &ids)
 
Dataset< DatasetImplcopy () const override
 
Dataset< DatasetImplcreateSubsetFromSelection (const QString &guiName, const Dataset< DatasetImpl > &parentDataSet=Dataset< DatasetImpl >(), const bool &visible=true) const override
 
QIcon getIcon (const QColor &color=Qt::black) const override
 
std::vector< std::uint32_t > & getSelectionIndices () override
 
void setSelectionIndices (const std::vector< std::uint32_t > &indices) override
 
QStringList getSelectionNames () const
 
void setSelectionNames (const QStringList &clusterNames)
 
bool canSelect () const override
 
bool canSelectAll () const override
 
bool canSelectNone () const override
 
bool canSelectInvert () const override
 
void selectAll () override
 
void selectNone () override
 
void selectInvert () override
 
std::vector< std::uint32_t > getSelectedIndices () const
 
void fromVariantMap (const QVariantMap &variantMap) override
 
QVariantMap toVariantMap () const override
 
- Public Member Functions inherited from hdps::DatasetImpl
 DatasetImpl (CoreInterface *core, const QString &rawDataName, const QString &id="")
 
virtual ~DatasetImpl ()
 
StorageType getStorageType () const
 
void setStorageType (const StorageType &storageType)
 
QString getGuiName () const
 
bool isFull () const
 
bool isDerivedData () const
 
DataType getDataType () const
 
template<typename DatasetType >
Dataset< DatasetType > getSourceDataset () const
 
void setSourceDataSet (const Dataset< DatasetImpl > &dataset)
 
template<typename DatasetType >
Dataset< DatasetType > getFullDataset () const
 
Dataset< DatasetImplgetSelection () const
 
template<typename DatasetType >
Dataset< DatasetType > getSelection () const
 
Dataset< DatasetImpl > & getSmartPointer ()
 
Dataset< DatasetImpltoSmartPointer () const
 
template<typename DatasetType >
Dataset< DatasetType > toSmartPointer () const
 
virtual QIcon getIcon (StorageType storageType, const QColor &color=Qt::black) const final
 
void makeSubsetOf (Dataset< DatasetImpl > fullDataset)
 
QString getRawDataKind () const
 
virtual std::uint64_t getRawDataSize () const
 
QString getRawDataSizeHumanReadable () const
 
QString getLocation () const override
 
DataHierarchyItemgetDataHierarchyItem ()
 
const DataHierarchyItemgetDataHierarchyItem () const
 
Dataset< DatasetImplgetParent () const
 
template<typename DatasetType >
Dataset< DatasetType > getParent () const
 
QVector< Dataset< DatasetImpl > > getChildren (const QVector< DataType > &dataTypes=QVector< DataType >()) const
 
QVector< Dataset< DatasetImpl > > getChildren (const DataType &filterDataType)
 
std::int32_t getSelectionSize () const
 
void lock ()
 
void unlock ()
 
bool isLocked () const
 
void setLocked (bool locked)
 
const bool operator== (const DatasetImpl &rhs) const
 
const bool operator!= (const DatasetImpl &rhs) const
 
QVariant getProperty (const QString &name, const QVariant &defaultValue=QVariant()) const
 
void setProperty (const QString &name, const QVariant &value)
 
bool hasProperty (const QString &name) const
 
QStringList propertyNames () const
 
void setAnalysis (plugin::AnalysisPlugin *analysis)
 
plugin::AnalysisPlugingetAnalysis ()
 
void fromVariantMap (const QVariantMap &variantMap) override
 
QVariantMap toVariantMap () const override
 
std::int32_t getGroupIndex () const
 
void setGroupIndex (const std::int32_t &groupIndex)
 
Datasets getProxyMembers () const
 
virtual void setProxyMembers (const Datasets &proxyMembers)
 
virtual bool mayProxy (const Datasets &proxyDatasets) const
 
bool isProxy () const
 
void addAction (hdps::gui::WidgetAction &widgetAction)
 
hdps::gui::WidgetActions getActions () const
 
QMenu * getContextMenu (QWidget *parent=nullptr) override
 
void populateContextMenu (QMenu *contextMenu)
 
void addLinkedData (const hdps::Dataset< DatasetImpl > &targetDataSet, hdps::SelectionMap &mapping)
 
const std::vector< hdps::LinkedData > & getLinkedData () const
 
std::vector< hdps::LinkedData > & getLinkedData ()
 
std::int32_t getLinkedDataFlags ()
 
void setLinkedDataFlags (std::int32_t linkedDataFlags)
 
void setLinkedDataFlag (std::int32_t linkedDataFlag, bool set=true)
 
bool hasLinkedDataFlag (std::int32_t linkedDataFlag)
 
virtual void resolveLinkedData (bool force=false)
 
QString getRawDataName () const
 
DatasetImploperator= (const DatasetImpl &other)
 
- Public Member Functions inherited from hdps::gui::WidgetAction
 WidgetAction (QObject *parent, const QString &title)
 
 ~WidgetAction ()
 
virtual WidgetActiongetParentAction () const final
 
virtual WidgetActions getParentActions () const final
 
virtual WidgetActions getChildren () const final
 
virtual bool isRoot () const final
 
virtual bool isLeaf () const final
 
virtual QWidget * createWidget (QWidget *parent) override final
 
virtual QWidget * createCollapsedWidget (QWidget *parent) const final
 
virtual QWidget * createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final
 
QWidget * createWidget (QWidget *parent, const std::int32_t &widgetFlags)
 
virtual std::int32_t getSortIndex () const final
 
virtual void setSortIndex (const std::int32_t &sortIndex) final
 
virtual std::int32_t getStretch () const final
 
virtual void setStretch (const std::int32_t &stretch) final
 
virtual bool getForceHidden () const final
 
virtual void setForceHidden (bool forceHidden) final
 
virtual bool isVisible () const final
 
virtual bool getForceDisabled () const final
 
virtual void setForceDisabled (bool forceDisabled) final
 
virtual bool isEnabled () const final
 
void setText (const QString &text)
 
virtual std::int32_t getDefaultWidgetFlags () const final
 
virtual void setDefaultWidgetFlags (const std::int32_t &widgetFlags) final
 
virtual void setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final
 
virtual HighlightOption getHighlighting () const final
 
virtual bool isHighlighted () const final
 
virtual void setHighlighting (const HighlightOption &highlighting) final
 
virtual void setHighlighted (bool highlighted) final
 
virtual void highlight () final
 
virtual void unHighlight () final
 
virtual Scope getScope () const final
 
virtual bool isPrivate () const final
 
virtual bool isPublic () const final
 
virtual bool isPublished () const final
 
virtual bool isConnected () const final
 
virtual bool mayConnectToPublicAction (const WidgetAction *publicAction) const final
 
virtual bool publish (const QString &name="", bool allowDuplicateName=false) final
 
virtual WidgetActiongetPublicAction () final
 
virtual WidgetActiongetPublicCopy () const final
 
virtual const WidgetActions getConnectedActions () const final
 
virtual WidgetActionsgetConnectedActions () final
 
virtual bool mayPublish (ConnectionContextFlag connectionContextFlags) const final
 
virtual bool mayConnect (ConnectionContextFlag connectionContextFlags) const final
 
virtual bool mayDisconnect (ConnectionContextFlag connectionContextFlags) const final
 
virtual std::int32_t getConnectionPermissions () const final
 
virtual bool isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final
 
virtual void setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final
 
virtual void setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final
 
virtual void setConnectionPermissionsToNone (bool recursive=false) final
 
virtual void setConnectionPermissionsToForceNone (bool recursive=false) final
 
virtual void setConnectionPermissionsToAll (bool recursive=false) final
 
virtual void cacheConnectionPermissions (bool recursive=false) final
 
virtual void restoreConnectionPermissions (bool recursive=false) final
 
virtual void startDrag () final
 
virtual bool isResettable () const final
 
virtual void reset () final
 
virtual void setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final
 
virtual void setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final
 
virtual QString getSettingsPrefix () const
 
virtual void loadFromSettings () final
 
virtual void saveToSettings () final
 
virtual QVector< WidgetAction * > findChildren (const QString &searchString, bool recursive=true) const final
 
virtual QSize getPopupSizeHint () const final
 
virtual void setPopupSizeHint (const QSize &popupSizeHint) final
 
virtual std::int32_t getConfiguration () const final
 
virtual bool isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final
 
virtual void setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final
 
virtual void setConfiguration (std::int32_t configuration, bool recursive=false) final
 
virtual QString getTypeString (bool humanFriendly=false) const final
 
void fromVariantMap (const QVariantMap &variantMap) override
 
QVariantMap toVariantMap () const override
 
virtual void cacheState (const QString &name="cache") final
 
virtual void restoreState (const QString &name="cache", bool remove=true) final
 
virtual void setStudioMode (bool studioMode, bool recursive=true) final
 
- Public Member Functions inherited from hdps::util::Serializable
 Serializable (const QString &serializationName="")
 
virtual QString getId () const final
 
virtual void setId (const QString &id) final
 
virtual QString getSerializationName () const final
 
virtual void setSerializationName (const QString &serializationName) final
 
virtual void fromParentVariantMap (const QVariantMap &parentVariantMap)
 
virtual void insertIntoVariantMap (QVariantMap &variantMap) const final
 
virtual void fromJsonDocument (const QJsonDocument &jsonDocument) final
 
virtual QJsonDocument toJsonDocument () const final
 
virtual void fromJsonFile (const QString &filePath="") final
 
virtual void toJsonFile (const QString &filePath="") final
 
virtual void makeUnique () final
 

Public Attributes

std::vector< unsigned int > indices
 
QSharedPointer< InfoAction_infoAction
 
EventListener _eventListener
 

Additional Inherited Members

- Public Types inherited from hdps::DatasetImpl
enum class  StorageType { Owner , Proxy }
 
enum  LinkedDataFlag { Send = 0x00001 , Receive = 0x00002 , SendReceive = Send | Receive }
 
- Public Types inherited from hdps::gui::WidgetAction
enum class  Scope { Private , Public }
 
enum class  HighlightOption { None , Moderate , Strong }
 
enum class  ConfigurationFlag {
  VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 ,
  ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0
}
 
enum  ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api | Gui }
 ‍** Describes the connection context options *‍/ More...
 
enum class  ConnectionPermissionFlag {
  None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi | PublishViaGui ,
  ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi | ConnectViaGui , DisconnectViaApi = 0x00040 ,
  DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi | DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui | ConnectViaApiAndGui | DisconnectViaApiAndGui ,
  Default = All
}
 
- Public Types inherited from hdps::util::Serializable
enum class  State { Idle , Reading , Writing }
 
- Signals inherited from hdps::gui::WidgetAction
void idChanged (const QString &id)
 
void sortIndexChanged (std::int32_t sortIndex)
 
void stretchChanged (std::int32_t stretch)
 
void forceHiddenChanged (bool forceHidden)
 
void forceDisabledChanged (bool forceDisabled)
 
void highlightingChanged (const HighlightOption &highlightOption)
 
void isPublishedChanged (const bool &isPublished)
 
void isConnectedChanged (const bool &isConnected)
 
void actionConnected (WidgetAction *action)
 
void actionDisconnected (WidgetAction *action)
 
void connectionPermissionsChanged (std::int32_t connectionPermissions)
 
void configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)
 
void configurationChanged (std::int32_t configuration)
 
void scopeChanged (const Scope &scope)
 
void textChanged (const QString &text)
 
void locationChanged (const QString &location)
 
- Static Public Member Functions inherited from hdps::util::Serializable
static QString createId ()
 
- Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString > scopeNames
 
- Protected Member Functions inherited from hdps::DatasetImpl
template<class DataType >
DataTypegetRawData () const
 
void setAll (bool all)
 
- Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void makePublic (bool recursive=true) final
 
virtual void connectToPublicAction (WidgetAction *publicAction, bool recursive)
 
virtual void connectToPublicActionByName (const QString &publicActionName) final
 
virtual void disconnectFromPublicAction (bool recursive)
 
virtual QWidget * getWidget (QWidget *parent, const std::int32_t &widgetFlags)
 
- Static Protected Member Functions inherited from hdps::util::Serializable
static void fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)
 
static void fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)
 
static QVariantMap toVariantMap (const Serializable *serializable)
 
static void insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)
 
static void insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)
 
- Protected Attributes inherited from hdps::DatasetImpl
CoreInterface_core
 

Constructor & Destructor Documentation

◆ Clusters()

Clusters::Clusters ( CoreInterface core,
QString  dataName,
const QString &  guid = "" 
)
inline

◆ ~Clusters()

Clusters::~Clusters ( )
inlineoverride

Member Function Documentation

◆ addCluster()

void Clusters::addCluster ( Cluster cluster)

Adds a cluster

Parameters
clusterCluster to add

◆ canSelect()

bool Clusters::canSelect ( ) const
overridevirtual

Determines whether items can be selected

Implements hdps::DatasetImpl.

◆ canSelectAll()

bool Clusters::canSelectAll ( ) const
overridevirtual

Determines whether all items can be selected

Implements hdps::DatasetImpl.

◆ canSelectInvert()

bool Clusters::canSelectInvert ( ) const
overridevirtual

Determines whether the item selection can be inverted (more than one)

Implements hdps::DatasetImpl.

◆ canSelectNone()

bool Clusters::canSelectNone ( ) const
overridevirtual

Determines whether there are any items which can be deselected

Implements hdps::DatasetImpl.

◆ copy()

Dataset< DatasetImpl > Clusters::copy ( ) const
inlineoverridevirtual

Get a copy of the dataset

Returns
Smart pointer to copy of dataset

Implements hdps::DatasetImpl.

◆ createSubsetFromSelection()

Dataset< DatasetImpl > Clusters::createSubsetFromSelection ( const QString &  guiName,
const Dataset< DatasetImpl > &  parentDataSet = Dataset<DatasetImpl>(),
const bool &  visible = true 
) const
inlineoverridevirtual

Create subset from the current selection and specify where the subset will be placed in the data hierarchy

Parameters
guiNameName of the subset in the GUI
parentDataSetSmart pointer to parent dataset in the data hierarchy (default is below the set)
visibleWhether the subset will be visible in the UI
Returns
Smart pointer to the created subset

Implements hdps::DatasetImpl.

◆ fromVariantMap()

void Clusters::fromVariantMap ( const QVariantMap &  variantMap)
overridevirtual

Load widget action from variant

Parameters
Variantrepresentation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getClusters() [1/2]

QVector< Cluster > & Clusters::getClusters ( )
inline

◆ getClusters() [2/2]

const QVector< Cluster > & Clusters::getClusters ( ) const
inline

◆ getIcon()

QIcon Clusters::getIcon ( const QColor &  color = Qt::black) const
overridevirtual

Get plugin icon

Parameters
colorIcon color for flat (font) icons
Returns
Icon

Implements hdps::DatasetImpl.

◆ getSelectedIndices()

std::vector< std::uint32_t > Clusters::getSelectedIndices ( ) const

Gets concatenated indices for all selected clusters

◆ getSelectionIndices()

std::vector< std::uint32_t > & Clusters::getSelectionIndices ( )
overridevirtual

Get selection indices

Returns
Selection indices

Implements hdps::DatasetImpl.

◆ getSelectionNames()

QStringList Clusters::getSelectionNames ( ) const

Get selection names

Returns
Selected cluster names

◆ init()

void Clusters::init ( )
overridevirtual

Performs startup initialization

Reimplemented from hdps::DatasetImpl.

◆ removeClusterById()

void Clusters::removeClusterById ( const QString &  id)

Removes a cluster by its unique identifier

Parameters
idUnique identifier of the cluster to remove

◆ removeClustersById()

void Clusters::removeClustersById ( const QStringList &  ids)

Remove clusters by their unique identifiers

Parameters
idsUnique identifiers of the clusters to remove

◆ selectAll()

void Clusters::selectAll ( )
overridevirtual

Select all items

Implements hdps::DatasetImpl.

◆ selectInvert()

void Clusters::selectInvert ( )
overridevirtual

Invert item selection

Implements hdps::DatasetImpl.

◆ selectNone()

void Clusters::selectNone ( )
overridevirtual

Deselect all items

Implements hdps::DatasetImpl.

◆ setSelectionIndices()

void Clusters::setSelectionIndices ( const std::vector< std::uint32_t > &  indices)
overridevirtual

Select by indices

Parameters
indicesSelection indices

Implements hdps::DatasetImpl.

◆ setSelectionNames()

void Clusters::setSelectionNames ( const QStringList &  clusterNames)

Select by name

Parameters
clusterNamesCluster names

◆ toVariantMap()

QVariantMap Clusters::toVariantMap ( ) const
overridevirtual

Save widget action to variant

Returns
Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Member Data Documentation

◆ _eventListener

EventListener Clusters::_eventListener

Shared pointer to info action

◆ _infoAction

QSharedPointer<InfoAction> Clusters::_infoAction

◆ indices

std::vector<unsigned int> Clusters::indices

The documentation for this class was generated from the following files: