ManiVault 1.0.0
A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data
Loading...
Searching...
No Matches
hdps::DatasetImpl Class Referenceabstract

#include <Set.h>

Inheritance diagram for hdps::DatasetImpl:
hdps::gui::WidgetAction hdps::util::Serializable Clusters Colors Images Points Text

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< DatasetImplcopy () const =0
 
virtual Dataset< DatasetImplcreateSubsetFromSelection (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< 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 (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
 
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)
 
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::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
 

Protected Member Functions

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)
 

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)
 

Detailed Description

Dataset implementation class Base dataset class from which concrete dataset classes derive

Member Enumeration Documentation

◆ LinkedDataFlag

Linked data propagation flags

Enumerator
Send 
Receive 

The set may send linked propagate linked data

SendReceive 

The set may receive linked data

◆ StorageType

enum class hdps::DatasetImpl::StorageType
strong

Type of storage

Enumerator
Owner 
Proxy 

The set is the data owner (has raw data) The set does not have raw data, it relies on proxy datasets to obtain data

Constructor & Destructor Documentation

◆ DatasetImpl()

hdps::DatasetImpl::DatasetImpl ( CoreInterface core,
const QString &  rawDataName,
const QString &  id = "" 
)

Constructor

Parameters
corePointer to the core
rawDataNameName of the raw data
idGlobally unique dataset identifier

◆ ~DatasetImpl()

hdps::DatasetImpl::~DatasetImpl ( )
virtual

Destructor

Member Function Documentation

◆ addAction()

void hdps::DatasetImpl::addAction ( hdps::gui::WidgetAction widgetAction)

Returns list of shared action widgets

◆ addLinkedData()

void hdps::DatasetImpl::addLinkedData ( const hdps::Dataset< DatasetImpl > &  targetDataSet,
hdps::SelectionMap mapping 
)

◆ canSelect()

virtual bool hdps::DatasetImpl::canSelect ( ) const
pure virtual

Determines whether items can be selected

Implemented in Clusters, Colors, Images, Points, and Text.

◆ canSelectAll()

virtual bool hdps::DatasetImpl::canSelectAll ( ) const
pure virtual

Determines whether all items can be selected

Implemented in Clusters, Colors, Images, Points, and Text.

◆ canSelectInvert()

virtual bool hdps::DatasetImpl::canSelectInvert ( ) const
pure virtual

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

Implemented in Clusters, Colors, Images, Points, and Text.

◆ canSelectNone()

virtual bool hdps::DatasetImpl::canSelectNone ( ) const
pure virtual

Determines whether there are any items which can be deselected

Implemented in Clusters, Colors, Images, Points, and Text.

◆ copy()

virtual Dataset< DatasetImpl > hdps::DatasetImpl::copy ( ) const
pure virtual

Get a copy of the dataset

Returns
Smart pointer to copy of dataset

Implemented in Clusters, Colors, Images, Points, and Text.

◆ createSubsetFromSelection()

virtual Dataset< DatasetImpl > hdps::DatasetImpl::createSubsetFromSelection ( const QString &  guiName,
const Dataset< DatasetImpl > &  parentDataSet = DatasetDatasetImpl >(),
const bool &  visible = true 
) const
pure virtual

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

Implemented in Clusters, Colors, Text, Images, and Points.

◆ fromVariantMap()

void hdps::DatasetImpl::fromVariantMap ( const QVariantMap &  variantMap)
overridevirtual

Load widget action from variant

Parameters
Variantrepresentation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in Images, and Points.

◆ getActions()

hdps::gui::WidgetActions hdps::DatasetImpl::getActions ( ) const

Returns list of shared action widgets

◆ getAnalysis()

hdps::plugin::AnalysisPlugin * hdps::DatasetImpl::getAnalysis ( )

Get analysis

Returns
Pointer to analysis plugin

◆ getChildren() [1/2]

QVector< hdps::Dataset< hdps::DatasetImpl > > hdps::DatasetImpl::getChildren ( const DataType filterDataType)

Get child datasets (if any) of the specified type

Parameters
filterDataTypeType of data to filter
Returns
Child datasets of the dataset type

◆ getChildren() [2/2]

QVector< Dataset< DatasetImpl > > hdps::DatasetImpl::getChildren ( const QVector< DataType > &  dataTypes = QVector<DataType>()) const

Get child datasets (if any) of the specified type(s)

Parameters
dataTypesDataset type(s) to filter out
Returns
Child datasets of the dataset type(s)

◆ getContextMenu()

QMenu * hdps::DatasetImpl::getContextMenu ( QWidget *  parent = nullptr)
overridevirtual

Get the context menu

Parameters
parentParent widget
Returns
Context menu

Reimplemented from hdps::gui::WidgetAction.

◆ getDataHierarchyItem() [1/2]

DataHierarchyItem & hdps::DatasetImpl::getDataHierarchyItem ( )

Get reference to data hierarchy item

◆ getDataHierarchyItem() [2/2]

const DataHierarchyItem & hdps::DatasetImpl::getDataHierarchyItem ( ) const

Get reference to data hierarchy item

◆ getDataType()

hdps::DataType hdps::DatasetImpl::getDataType ( ) const

Returns the data type of the raw data associated with this dataset

◆ getFullDataset()

template<typename DatasetType >
Dataset< DatasetType > hdps::DatasetImpl::getFullDataset ( ) const
inline

Returns the original full dataset this subset was created from

◆ getGroupIndex()

std::int32_t hdps::DatasetImpl::getGroupIndex ( ) const

Get group index

◆ getGuiName()

QString hdps::DatasetImpl::getGuiName ( ) const

Get the GUI name of the dataset

◆ getIcon() [1/2]

virtual QIcon hdps::DatasetImpl::getIcon ( const QColor &  color = Qt::black) const
pure virtual

Get set icon

Parameters
colorIcon color for flat (font) icons
Returns
Icon

Implemented in Clusters, Colors, Images, Points, and Text.

◆ getIcon() [2/2]

QIcon hdps::DatasetImpl::getIcon ( StorageType  storageType,
const QColor &  color = Qt::black 
) const
finalvirtual

Get icon for storageType

Parameters
storageTypeData storage type
colorIcon color for flat (font) icons
Returns
Icon for storageType

◆ getLinkedData() [1/2]

std::vector< hdps::LinkedData > & hdps::DatasetImpl::getLinkedData ( )

◆ getLinkedData() [2/2]

const std::vector< hdps::LinkedData > & hdps::DatasetImpl::getLinkedData ( ) const

◆ getLinkedDataFlags()

std::int32_t hdps::DatasetImpl::getLinkedDataFlags ( )

Get flags for linked data

Returns
Flags for linked data

◆ getLocation()

QString hdps::DatasetImpl::getLocation ( ) const
overridevirtual

Get location

Returns
Path relative to the top-level action

Reimplemented from hdps::gui::WidgetAction.

◆ getParent() [1/2]

hdps::Dataset< hdps::DatasetImpl > hdps::DatasetImpl::getParent ( ) const

Get parent dataset (if any)

◆ getParent() [2/2]

template<typename DatasetType >
Dataset< DatasetType > hdps::DatasetImpl::getParent ( ) const
inline

Get parent dataset (if any)

◆ getProperty()

QVariant hdps::DatasetImpl::getProperty ( const QString &  name,
const QVariant &  defaultValue = QVariant() 
) const

Get property in variant form

Parameters
nameName of the property
defaultValueDefault value
Returns
Property in variant form

◆ getProxyMembers()

hdps::Datasets hdps::DatasetImpl::getProxyMembers ( ) const

Get member datasets

Returns
Proxy member datasets

◆ getRawData()

template<class DataType >
DataType & hdps::DatasetImpl::getRawData ( ) const
inlineprotected

Get raw data

◆ getRawDataKind()

QString hdps::DatasetImpl::getRawDataKind ( ) const

Get plugin kind of the raw data

Returns
Plugin kind of the raw data

◆ getRawDataName()

QString hdps::DatasetImpl::getRawDataName ( ) const

Get the name of the raw data

◆ getRawDataSize()

std::uint64_t hdps::DatasetImpl::getRawDataSize ( ) const
virtual

Get amount of data occupied by the raw data

Returns
Size of the raw data in bytes

Reimplemented in Points.

◆ getRawDataSizeHumanReadable()

QString hdps::DatasetImpl::getRawDataSizeHumanReadable ( ) const

Get amount of data occupied by the raw data in human readable string format

Returns
Size of the raw data in bytes in human readable string format

◆ getSelection() [1/2]

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.

Returns
The selection associated with this data set

◆ getSelection() [2/2]

template<typename DatasetType >
Dataset< DatasetType > hdps::DatasetImpl::getSelection ( ) const
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.

Returns
The selection of dataset type associated with this data set

◆ getSelectionIndices()

virtual std::vector< std::uint32_t > & hdps::DatasetImpl::getSelectionIndices ( )
pure virtual

Get selection indices

Returns
Selection indices

Implemented in Clusters, Colors, Images, Points, and Text.

◆ getSelectionSize()

std::int32_t hdps::DatasetImpl::getSelectionSize ( ) const

Get size of the selection

◆ getSmartPointer()

hdps::Dataset< hdps::DatasetImpl > & hdps::DatasetImpl::getSmartPointer ( )

Get reference to smart pointer which is owned by the set

Returns
Reference to smart pointer which is owned by the set

◆ getSourceDataset()

template<typename DatasetType >
Dataset< DatasetType > hdps::DatasetImpl::getSourceDataset ( ) const
inline

Get source dataset if the given set is derived

◆ getStorageType()

hdps::DatasetImpl::StorageType hdps::DatasetImpl::getStorageType ( ) const

Get the data storage type

Returns
Data storage type

◆ hasLinkedDataFlag()

bool hdps::DatasetImpl::hasLinkedDataFlag ( std::int32_t  linkedDataFlag)

Determine whether linkedDataFlag is set or not

Parameters
linkedDataFlagLinked data
Returns
Boolean determining linkedDataFlag Linked data

◆ hasProperty()

bool hdps::DatasetImpl::hasProperty ( const QString &  name) const

Determines whether a property with a give name exists

Parameters
nameName of the property
valueIf property with the given name exists

◆ init()

void hdps::DatasetImpl::init ( )
virtual

Performs startup initialization

Reimplemented in Clusters, Images, and Points.

◆ isDerivedData()

bool hdps::DatasetImpl::isDerivedData ( ) const

Returns whether the dataset is derived

◆ isFull()

bool hdps::DatasetImpl::isFull ( ) const

Returns true if this set represents the full data and false if it's a subset

◆ isLocked()

bool hdps::DatasetImpl::isLocked ( ) const

Get whether the dataset is locked

Returns
Boolean indicating whether the dataset is locked

◆ isProxy()

bool hdps::DatasetImpl::isProxy ( ) const

Establish whether the set is a proxy dataset (comprised of foreign datasets)

Returns
Boolean indicating whether the set is a proxy dataset

◆ lock()

void hdps::DatasetImpl::lock ( )

Lock the dataset

◆ makeSubsetOf()

void hdps::DatasetImpl::makeSubsetOf ( Dataset< DatasetImpl fullDataset)

Makes this set a subset of a full dataset

Parameters
fullDatasetSmart pointer to full dataset

◆ mayProxy()

bool hdps::DatasetImpl::mayProxy ( const Datasets proxyDatasets) const
virtual

Establish whether a proxy dataset may be created with candidate proxyDatasets

Parameters
proxyDatasetsCandidate proxy datasets
Returns
Boolean indicating whether a proxy dataset may be created with candidate proxyDatasets

Reimplemented in Points.

◆ operator!=()

const bool hdps::DatasetImpl::operator!= ( const DatasetImpl rhs) const
inline

Inequality operator

Parameters
rhsRight-hand-side operator

◆ operator=()

DatasetImpl & hdps::DatasetImpl::operator= ( const DatasetImpl other)
inline

Assignment operator

Parameters
otherReference to assign from

◆ operator==()

const bool hdps::DatasetImpl::operator== ( const DatasetImpl rhs) const
inline

Equality operator

Parameters
rhsRight-hand-side operator

◆ populateContextMenu()

void hdps::DatasetImpl::populateContextMenu ( QMenu *  contextMenu)

Populates existing menu with actions menus

Parameters
contextMenuContext menu to populate

◆ propertyNames()

QStringList hdps::DatasetImpl::propertyNames ( ) const

Returns a list of available property names

◆ resolveLinkedData()

virtual void hdps::DatasetImpl::resolveLinkedData ( bool  force = false)
inlinevirtual

Resolves linked data for the dataset

Parameters
forceForce update of all linked data (ignores linked data flags)

Reimplemented in Points.

◆ selectAll()

virtual void hdps::DatasetImpl::selectAll ( )
pure virtual

Select all items

Implemented in Clusters, Colors, Images, Points, and Text.

◆ selectInvert()

virtual void hdps::DatasetImpl::selectInvert ( )
pure virtual

Invert item selection

Implemented in Clusters, Colors, Images, Points, and Text.

◆ selectNone()

virtual void hdps::DatasetImpl::selectNone ( )
pure virtual

Deselect all items

Implemented in Clusters, Colors, Images, Points, and Text.

◆ setAll()

void hdps::DatasetImpl::setAll ( bool  all)
protected

Set whether this set represents all the data or only a subset

Parameters
allWhether this is a full dataset

◆ setAnalysis()

void hdps::DatasetImpl::setAnalysis ( plugin::AnalysisPlugin analysis)

Set analysis

Parameters
analysisPointer to analysis plugin

◆ setGroupIndex()

void hdps::DatasetImpl::setGroupIndex ( const std::int32_t &  groupIndex)

Set group index

Parameters
groupIndexgroup index

◆ setLinkedDataFlag()

void hdps::DatasetImpl::setLinkedDataFlag ( std::int32_t  linkedDataFlag,
bool  set = true 
)

Set linked data flag

Parameters
linkedDataFlagLinked data

◆ setLinkedDataFlags()

void hdps::DatasetImpl::setLinkedDataFlags ( std::int32_t  linkedDataFlags)

Set flags for linked data

Parameters
linkedDataFlagsFlags for linked data

◆ setLocked()

void hdps::DatasetImpl::setLocked ( bool  locked)

Set whether the dataset is locked @parem locked Boolean indicating whether the dataset is locked

◆ setProperty()

void hdps::DatasetImpl::setProperty ( const QString &  name,
const QVariant &  value 
)

Set property

Parameters
nameName of the property
valueProperty value

◆ setProxyMembers()

void hdps::DatasetImpl::setProxyMembers ( const Datasets proxyMembers)
virtual

Set the proxy member datasets (automatically sets the dataset type to Type::Proxy)

Parameters
proxyMembersProxy member datasets

Reimplemented in Points.

◆ setSelectionIndices()

virtual void hdps::DatasetImpl::setSelectionIndices ( const std::vector< std::uint32_t > &  indices)
pure virtual

Select by indices

Parameters
indicesSelection indices

Implemented in Clusters, Colors, Images, Points, and Text.

◆ setSourceDataSet()

void hdps::DatasetImpl::setSourceDataSet ( const Dataset< DatasetImpl > &  dataset)

Marks this dataset as derived and sets the source dataset globally unique identifier

Parameters
datasetSmart pointer to the source dataset

◆ setStorageType()

void hdps::DatasetImpl::setStorageType ( const StorageType storageType)

Set the data storage type

Parameters
typeData storage type

◆ toSmartPointer() [1/2]

hdps::Dataset< hdps::DatasetImpl > hdps::DatasetImpl::toSmartPointer ( ) const

Get smart pointer to set

Returns
Smart pointer to the set

◆ toSmartPointer() [2/2]

template<typename DatasetType >
Dataset< DatasetType > hdps::DatasetImpl::toSmartPointer ( ) const
inline

Get smart pointer to set

Returns
Smart pointer to the set

◆ toVariantMap()

QVariantMap hdps::DatasetImpl::toVariantMap ( ) const
overridevirtual

Save widget action to variant

Returns
Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in Images, and Points.

◆ unlock()

void hdps::DatasetImpl::unlock ( )

Unlock the dataset

Friends And Related Symbol Documentation

◆ Core

friend class Core
friend

◆ CoreInterface

friend class CoreInterface
friend

Smart pointer to own dataset

◆ DataManager

friend class DataManager
friend

◆ EventListener

friend class EventListener
friend

◆ SmartDataset

template<typename DatasetType >
friend class SmartDataset
friend

Member Data Documentation

◆ _core

CoreInterface* hdps::DatasetImpl::_core
protected

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