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

#include <PointData.h>

Inheritance diagram for PointData:
hdps::plugin::RawData hdps::plugin::Plugin hdps::gui::WidgetAction hdps::util::Serializable

Public Types

using ElementTypeSpecifier = VectorHolder::ElementTypeSpecifier
 
template<std::size_t N>
using ElementTypeAt = VectorHolder::ElementTypeAt< N >
 
- 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

 PointData (PluginFactory *factory)
 
 ~PointData (void) override
 
void init () override
 
hdps::Dataset< hdps::DatasetImplcreateDataSet (const QString &guid="") const override
 
unsigned int getNumPoints () const
 
unsigned int getNumDimensions () const
 
std::uint64_t getRawDataSize () const
 
template<typename ReturnType = void, typename FunctionObject >
ReturnType constVisitFromBeginToEnd (FunctionObject functionObject) const
 
template<typename ReturnType = void, typename FunctionObject >
ReturnType visitFromBeginToEnd (FunctionObject functionObject)
 
void extractFullDataForDimension (std::vector< float > &result, const int dimensionIndex) const
 
void extractFullDataForDimensions (std::vector< hdps::Vector2f > &result, const int dimensionIndex1, const int dimensionIndex2) const
 
void extractDataForDimensions (std::vector< hdps::Vector2f > &result, const int dimensionIndex1, const int dimensionIndex2, const std::vector< unsigned int > &indices) const
 
template<typename ResultContainer , typename DimensionIndices >
void populateFullDataForDimensions (ResultContainer &resultContainer, const DimensionIndices &dimensionIndices) const
 
template<typename ResultContainer , typename DimensionIndices , typename Indices >
void populateDataForDimensions (ResultContainer &resultContainer, const DimensionIndices &dimensionIndices, const Indices &indices) const
 
const std::vector< QString > & getDimensionNames () const
 
void setElementType (const ElementTypeSpecifier elementTypSpecifier)
 
template<typename T >
void setElementType ()
 
template<typename T >
void convertData (const T *const data, const std::size_t numPoints, const std::size_t numDimensions)
 
template<typename T >
void convertData (const T &inputDataContainer, const std::size_t numDimensions)
 
template<typename T >
void setData (const T *const data, const std::size_t numPoints, const std::size_t numDimensions)
 
void setData (std::nullptr_t data, std::size_t numPoints, std::size_t numDimensions)
 Convenience overload to allow clearing the data by setData(nullptr, 0, numDimensions).
 
template<typename T >
void setData (const std::vector< T > &data, const std::size_t numDimensions)
 
template<typename T >
void setData (std::vector< T > &&data, const std::size_t numDimensions)
 
void setDimensionNames (const std::vector< QString > &dimNames)
 
float getValueAt (std::size_t index) const
 
void setValueAt (std::size_t index, float newValue)
 
virtual void fromVariantMap (const QVariantMap &variantMap) final
 
virtual QVariantMap toVariantMap () const final
 
- Public Member Functions inherited from hdps::plugin::RawData
 RawData (const PluginFactory *factory, const DataType &dataType)
 
 ~RawData () override
 
const DataTypegetDataType () const
 
- Public Member Functions inherited from hdps::plugin::Plugin
 Plugin (const PluginFactory *factory)
 
virtual ~Plugin ()
 
virtual const PluginFactorygetFactory () const final
 
QString getName () const
 
QString getGuiName () const
 
virtual QIcon getIcon () const final
 
QString getKind () const
 
Type getType () const
 
virtual QString getVersion () const
 
virtual bool hasHelp ()
 
virtual gui::TriggerActiongetTriggerHelpAction () final
 
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
 
QVariant getSetting (const QString &path, const QVariant &defaultValue=QVariant()) const
 
void setSetting (const QString &path, const QVariant &value)
 
virtual void destroy () final
 
gui::StringActiongetGuiNameAction ()
 
gui::TriggerActiongetDestroyAction ()
 
- 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
 
virtual QMenu * getContextMenu (QWidget *parent=nullptr)
 
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 QString getLocation () const
 
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
 

Static Public Member Functions

static constexpr auto getElementTypeNames ()
 
static constexpr auto getNumberOfSupportedElementTypes ()
 Returns the number of types, supported as element type of the internal data storage.
 
- Static Public Member Functions inherited from hdps::util::Serializable
static QString createId ()
 

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 Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString > scopeNames
 
- 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::plugin::Plugin
CoreInterface_core
 
const PluginFactory_factory
 
const QString _name
 
QMap< QString, QVariant > _properties
 
EventListener _eventListener
 
gui::StringAction _guiNameAction
 
gui::TriggerAction _destroyAction
 

Member Typedef Documentation

◆ ElementTypeAt

template<std::size_t N>
using PointData::ElementTypeAt = VectorHolder::ElementTypeAt<N>

Yields the n-th supported element type. Corresponds to the n-th entry in the array of type names, returned by getElementTypeNames().

◆ ElementTypeSpecifier

using PointData::ElementTypeSpecifier = VectorHolder::ElementTypeSpecifier

Constructor & Destructor Documentation

◆ PointData()

PointData::PointData ( PluginFactory factory)
inline

◆ ~PointData()

PointData::~PointData ( void  )
override

Member Function Documentation

◆ constVisitFromBeginToEnd()

template<typename ReturnType = void, typename FunctionObject >
ReturnType PointData::constVisitFromBeginToEnd ( FunctionObject  functionObject) const
inline

◆ convertData() [1/2]

template<typename T >
void PointData::convertData ( const T &  inputDataContainer,
const std::size_t  numDimensions 
)
inline

Converts the specified data to the internal data, using static_cast for each data element. Convenience overload, allowing an std::vector or an std::array as input data container.

◆ convertData() [2/2]

template<typename T >
void PointData::convertData ( const T *const  data,
const std::size_t  numPoints,
const std::size_t  numDimensions 
)
inline

Converts the specified data to the internal data, using static_cast for each data element. Sets the number of dimensions as specified. Ensures that the size of the internal data buffer corresponds to the number of points.

Note
This function does not affect the selected internal data type.

◆ createDataSet()

hdps::Dataset< DatasetImpl > PointData::createDataSet ( const QString &  guid = "") const
overridevirtual

Create dataset for raw data

Parameters
guidGlobally unique dataset identifier (use only for deserialization)
Returns
Smart pointer to dataset

Implements hdps::plugin::RawData.

◆ extractDataForDimensions()

void PointData::extractDataForDimensions ( std::vector< hdps::Vector2f > &  result,
const int  dimensionIndex1,
const int  dimensionIndex2,
const std::vector< unsigned int > &  indices 
) const

◆ extractFullDataForDimension()

void PointData::extractFullDataForDimension ( std::vector< float > &  result,
const int  dimensionIndex 
) const

◆ extractFullDataForDimensions()

void PointData::extractFullDataForDimensions ( std::vector< hdps::Vector2f > &  result,
const int  dimensionIndex1,
const int  dimensionIndex2 
) const

◆ fromVariantMap()

void PointData::fromVariantMap ( const QVariantMap &  variantMap)
finalvirtual

Load point data from variant map

Parameters
Variantmap representation of the point data

Reimplemented from hdps::plugin::Plugin.

◆ getDimensionNames()

const std::vector< QString > & PointData::getDimensionNames ( ) const

◆ getElementTypeNames()

static constexpr auto PointData::getElementTypeNames ( )
inlinestaticconstexpr

◆ getNumberOfSupportedElementTypes()

static constexpr auto PointData::getNumberOfSupportedElementTypes ( )
inlinestaticconstexpr

Returns the number of types, supported as element type of the internal data storage.

◆ getNumDimensions()

unsigned int PointData::getNumDimensions ( ) const

◆ getNumPoints()

unsigned int PointData::getNumPoints ( ) const

◆ getRawDataSize()

std::uint64_t PointData::getRawDataSize ( ) const
inline

Get amount of data occupied by the raw data

Returns
Size of the raw data in bytes

◆ getValueAt()

float PointData::getValueAt ( std::size_t  index) const

◆ init()

void PointData::init ( )
overridevirtual

Can be implemented to initialize the plugin to a certain state. This function gets called when the plugin is first instantiated.

Implements hdps::plugin::Plugin.

◆ populateDataForDimensions()

template<typename ResultContainer , typename DimensionIndices , typename Indices >
void PointData::populateDataForDimensions ( ResultContainer &  resultContainer,
const DimensionIndices &  dimensionIndices,
const Indices &  indices 
) const
inline

◆ populateFullDataForDimensions()

template<typename ResultContainer , typename DimensionIndices >
void PointData::populateFullDataForDimensions ( ResultContainer &  resultContainer,
const DimensionIndices &  dimensionIndices 
) const
inline

◆ setData() [1/4]

template<typename T >
void PointData::setData ( const std::vector< T > &  data,
const std::size_t  numDimensions 
)
inline

Copies the data from the specified vector into the internal data, sets the number of dimensions as specified, and sets the selected internal data type according to the specified data type T.

◆ setData() [2/4]

template<typename T >
void PointData::setData ( const T *const  data,
const std::size_t  numPoints,
const std::size_t  numDimensions 
)
inline

Copies the specified data into the internal data, sets the number of dimensions as specified, and sets the selected internal data type according to the specified data type T.

◆ setData() [3/4]

void PointData::setData ( std::nullptr_t  data,
std::size_t  numPoints,
std::size_t  numDimensions 
)

Convenience overload to allow clearing the data by setData(nullptr, 0, numDimensions).

◆ setData() [4/4]

template<typename T >
void PointData::setData ( std::vector< T > &&  data,
const std::size_t  numDimensions 
)
inline

Efficiently "moves" the data from the specified vector into the internal data, sets the number of dimensions as specified, and sets the selected internal data type according to the specified data type T.

◆ setDimensionNames()

void PointData::setDimensionNames ( const std::vector< QString > &  dimNames)

◆ setElementType() [1/2]

template<typename T >
void PointData::setElementType ( )
inline

◆ setElementType() [2/2]

void PointData::setElementType ( const ElementTypeSpecifier  elementTypSpecifier)
inline

◆ setValueAt()

void PointData::setValueAt ( std::size_t  index,
float  newValue 
)

◆ toVariantMap()

QVariantMap PointData::toVariantMap ( ) const
finalvirtual

Save point data to variant map

Returns
Variant map representation of the point data

Reimplemented from hdps::plugin::Plugin.

◆ visitFromBeginToEnd()

template<typename ReturnType = void, typename FunctionObject >
ReturnType PointData::visitFromBeginToEnd ( FunctionObject  functionObject)
inline

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