|
ManiVault 1.0.0
A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data
|
#include <Set.h>
Public Types | |
| 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 } |
Public Member Functions | |
| DatasetImpl (CoreInterface *core, const QString &rawDataName, const QString &id="") | |
| virtual | ~DatasetImpl () |
| virtual void | init () |
| virtual Dataset< DatasetImpl > | copy () const =0 |
| virtual Dataset< DatasetImpl > | createSubsetFromSelection (const QString &guiName, const Dataset< DatasetImpl > &parentDataSet=Dataset< DatasetImpl >(), const bool &visible=true) const =0 |
| 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< DatasetImpl > | getSelection () const |
| template<typename DatasetType > | |
| Dataset< DatasetType > | getSelection () const |
| Dataset< DatasetImpl > & | getSmartPointer () |
| Dataset< DatasetImpl > | toSmartPointer () const |
| template<typename DatasetType > | |
| Dataset< DatasetType > | toSmartPointer () const |
| virtual QIcon | getIcon (const QColor &color=Qt::black) const =0 |
| 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 |
| DataHierarchyItem & | getDataHierarchyItem () |
| const DataHierarchyItem & | getDataHierarchyItem () const |
| Dataset< DatasetImpl > | getParent () 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) |
| virtual std::vector< std::uint32_t > & | getSelectionIndices ()=0 |
| virtual void | setSelectionIndices (const std::vector< std::uint32_t > &indices)=0 |
| std::int32_t | getSelectionSize () const |
| virtual bool | canSelect () const =0 |
| virtual bool | canSelectAll () const =0 |
| virtual bool | canSelectNone () const =0 |
| virtual bool | canSelectInvert () const =0 |
| virtual void | selectAll ()=0 |
| virtual void | selectNone ()=0 |
| virtual void | selectInvert ()=0 |
| 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::AnalysisPlugin * | getAnalysis () |
| 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 |
| DatasetImpl & | operator= (const DatasetImpl &other) |
Public Member Functions inherited from hdps::gui::WidgetAction | |
| WidgetAction (QObject *parent, const QString &title) | |
| ~WidgetAction () | |
| virtual WidgetAction * | getParentAction () 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 WidgetAction * | getPublicAction () final |
| virtual WidgetAction * | getPublicCopy () const final |
| virtual const WidgetActions | getConnectedActions () const final |
| virtual WidgetActions & | getConnectedActions () 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 |
Protected Member Functions | |
| template<class DataType > | |
| DataType & | getRawData () 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) |
Protected Attributes | |
| CoreInterface * | _core |
Friends | |
| class | CoreInterface |
| class | Core |
| class | DataManager |
| class | EventListener |
| template<typename DatasetType > | |
| class | SmartDataset |
Additional Inherited Members | |
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 |
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) |
Dataset implementation class Base dataset class from which concrete dataset classes derive
|
strong |
| hdps::DatasetImpl::DatasetImpl | ( | CoreInterface * | core, |
| const QString & | rawDataName, | ||
| const QString & | id = "" |
||
| ) |
Constructor
| core | Pointer to the core |
| rawDataName | Name of the raw data |
| id | Globally unique dataset identifier |
|
virtual |
Destructor
| void hdps::DatasetImpl::addAction | ( | hdps::gui::WidgetAction & | widgetAction | ) |
Returns list of shared action widgets
| void hdps::DatasetImpl::addLinkedData | ( | const hdps::Dataset< DatasetImpl > & | targetDataSet, |
| hdps::SelectionMap & | mapping | ||
| ) |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Create subset from the current selection and specify where the subset will be placed in the data hierarchy
| guiName | Name of the subset in the GUI |
| parentDataSet | Smart pointer to parent dataset in the data hierarchy (default is below the set) |
| visible | Whether the subset will be visible in the UI |
|
overridevirtual |
Load widget action from variant
| Variant | representation of the widget action |
Reimplemented from hdps::util::Serializable.
| hdps::gui::WidgetActions hdps::DatasetImpl::getActions | ( | ) | const |
Returns list of shared action widgets
| hdps::plugin::AnalysisPlugin * hdps::DatasetImpl::getAnalysis | ( | ) |
Get analysis
| QVector< hdps::Dataset< hdps::DatasetImpl > > hdps::DatasetImpl::getChildren | ( | const DataType & | filterDataType | ) |
Get child datasets (if any) of the specified type
| filterDataType | Type of data to filter |
| QVector< Dataset< DatasetImpl > > hdps::DatasetImpl::getChildren | ( | const QVector< DataType > & | dataTypes = QVector<DataType>() | ) | const |
Get child datasets (if any) of the specified type(s)
| dataTypes | Dataset type(s) to filter out |
|
overridevirtual |
Get the context menu
| parent | Parent widget |
Reimplemented from hdps::gui::WidgetAction.
| DataHierarchyItem & hdps::DatasetImpl::getDataHierarchyItem | ( | ) |
Get reference to data hierarchy item
| const DataHierarchyItem & hdps::DatasetImpl::getDataHierarchyItem | ( | ) | const |
Get reference to data hierarchy item
| hdps::DataType hdps::DatasetImpl::getDataType | ( | ) | const |
Returns the data type of the raw data associated with this dataset
|
inline |
Returns the original full dataset this subset was created from
| std::int32_t hdps::DatasetImpl::getGroupIndex | ( | ) | const |
Get group index
| QString hdps::DatasetImpl::getGuiName | ( | ) | const |
Get the GUI name of the dataset
|
pure virtual |
|
finalvirtual |
Get icon for storageType
| storageType | Data storage type |
| color | Icon color for flat (font) icons |
storageType | std::vector< hdps::LinkedData > & hdps::DatasetImpl::getLinkedData | ( | ) |
| const std::vector< hdps::LinkedData > & hdps::DatasetImpl::getLinkedData | ( | ) | const |
| std::int32_t hdps::DatasetImpl::getLinkedDataFlags | ( | ) |
Get flags for linked data
|
overridevirtual |
Get location
Reimplemented from hdps::gui::WidgetAction.
| hdps::Dataset< hdps::DatasetImpl > hdps::DatasetImpl::getParent | ( | ) | const |
Get parent dataset (if any)
|
inline |
Get parent dataset (if any)
| QVariant hdps::DatasetImpl::getProperty | ( | const QString & | name, |
| const QVariant & | defaultValue = QVariant() |
||
| ) | const |
Get property in variant form
| name | Name of the property |
| defaultValue | Default value |
| hdps::Datasets hdps::DatasetImpl::getProxyMembers | ( | ) | const |
Get member datasets
Get raw data
| QString hdps::DatasetImpl::getRawDataKind | ( | ) | const |
Get plugin kind of the raw data
| QString hdps::DatasetImpl::getRawDataName | ( | ) | const |
Get the name of the raw data
|
virtual |
Get amount of data occupied by the raw data
Reimplemented in Points.
| QString hdps::DatasetImpl::getRawDataSizeHumanReadable | ( | ) | const |
Get amount of data occupied by the raw data in human readable string format
| hdps::Dataset< hdps::DatasetImpl > hdps::DatasetImpl::getSelection | ( | ) | const |
Gets the selection associated with this data set. If the data set is derived then the selection of the source data will be returned. Otherwise, the selection of the set's data will be returned.
|
inline |
Gets the selection associated with this data set. If the data set is derived then the selection of the source data will be returned. Otherwise, the selection of the set's data will be returned.
|
pure virtual |
| std::int32_t hdps::DatasetImpl::getSelectionSize | ( | ) | const |
Get size of the selection
| hdps::Dataset< hdps::DatasetImpl > & hdps::DatasetImpl::getSmartPointer | ( | ) |
Get reference to smart pointer which is owned by the set
|
inline |
Get source dataset if the given set is derived
| hdps::DatasetImpl::StorageType hdps::DatasetImpl::getStorageType | ( | ) | const |
Get the data storage type
| bool hdps::DatasetImpl::hasLinkedDataFlag | ( | std::int32_t | linkedDataFlag | ) |
Determine whether linkedDataFlag is set or not
| linkedDataFlag | Linked data |
| bool hdps::DatasetImpl::hasProperty | ( | const QString & | name | ) | const |
Determines whether a property with a give name exists
| name | Name of the property |
| value | If property with the given name exists |
|
virtual |
| bool hdps::DatasetImpl::isDerivedData | ( | ) | const |
Returns whether the dataset is derived
| bool hdps::DatasetImpl::isFull | ( | ) | const |
Returns true if this set represents the full data and false if it's a subset
| bool hdps::DatasetImpl::isLocked | ( | ) | const |
Get whether the dataset is locked
| bool hdps::DatasetImpl::isProxy | ( | ) | const |
Establish whether the set is a proxy dataset (comprised of foreign datasets)
| void hdps::DatasetImpl::lock | ( | ) |
Lock the dataset
| void hdps::DatasetImpl::makeSubsetOf | ( | Dataset< DatasetImpl > | fullDataset | ) |
Makes this set a subset of a full dataset
| fullDataset | Smart pointer to full dataset |
|
virtual |
Establish whether a proxy dataset may be created with candidate proxyDatasets
| proxyDatasets | Candidate proxy datasets |
proxyDatasets Reimplemented in Points.
|
inline |
Inequality operator
| rhs | Right-hand-side operator |
|
inline |
Assignment operator
| other | Reference to assign from |
|
inline |
Equality operator
| rhs | Right-hand-side operator |
| void hdps::DatasetImpl::populateContextMenu | ( | QMenu * | contextMenu | ) |
Populates existing menu with actions menus
| contextMenu | Context menu to populate |
| QStringList hdps::DatasetImpl::propertyNames | ( | ) | const |
Returns a list of available property names
|
inlinevirtual |
Resolves linked data for the dataset
| force | Force update of all linked data (ignores linked data flags) |
Reimplemented in Points.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
protected |
Set whether this set represents all the data or only a subset
| all | Whether this is a full dataset |
| void hdps::DatasetImpl::setAnalysis | ( | plugin::AnalysisPlugin * | analysis | ) |
Set analysis
| analysis | Pointer to analysis plugin |
| void hdps::DatasetImpl::setGroupIndex | ( | const std::int32_t & | groupIndex | ) |
Set group index
| groupIndex | group index |
| void hdps::DatasetImpl::setLinkedDataFlag | ( | std::int32_t | linkedDataFlag, |
| bool | set = true |
||
| ) |
Set linked data flag
| linkedDataFlag | Linked data |
| void hdps::DatasetImpl::setLinkedDataFlags | ( | std::int32_t | linkedDataFlags | ) |
Set flags for linked data
| linkedDataFlags | Flags for linked data |
| void hdps::DatasetImpl::setLocked | ( | bool | locked | ) |
Set whether the dataset is locked @parem locked Boolean indicating whether the dataset is locked
| void hdps::DatasetImpl::setProperty | ( | const QString & | name, |
| const QVariant & | value | ||
| ) |
Set property
| name | Name of the property |
| value | Property value |
|
virtual |
Set the proxy member datasets (automatically sets the dataset type to Type::Proxy)
| proxyMembers | Proxy member datasets |
Reimplemented in Points.
|
pure virtual |
| void hdps::DatasetImpl::setSourceDataSet | ( | const Dataset< DatasetImpl > & | dataset | ) |
Marks this dataset as derived and sets the source dataset globally unique identifier
| dataset | Smart pointer to the source dataset |
| void hdps::DatasetImpl::setStorageType | ( | const StorageType & | storageType | ) |
Set the data storage type
| type | Data storage type |
| hdps::Dataset< hdps::DatasetImpl > hdps::DatasetImpl::toSmartPointer | ( | ) | const |
Get smart pointer to set
|
inline |
Get smart pointer to set
|
overridevirtual |
Save widget action to variant
Reimplemented from hdps::util::Serializable.
| void hdps::DatasetImpl::unlock | ( | ) |
Unlock the dataset
|
friend |
|
friend |
Smart pointer to own dataset
|
friend |
|
friend |
|
friend |
|
protected |