#include <mlParameterInfo.h>
Public Types | |
| typedef QVariantMap | DataType |
| typedef QString | KeyType |
| typedef QVariant | ValueType |
| Public Types inherited from ml::Base | |
| enum | PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream } |
| This enum describes the different persistence interfaces available. More... | |
Public Member Functions | |
| ParameterInfo ()=default | |
| ParameterInfo (const DataType &otherData) | |
| Allow initialization from a data object. | |
| ParameterInfo (DataType &&otherData) | |
| Allow to move data on construction. | |
| ParameterInfo (std::initializer_list< std::pair< KeyType, ValueType > > listOfKeyValuePairs) | |
| For convenience, allow initialization via { { "key1", value1 }, { "key2", value2 }, ... }. | |
| bool | operator== (const ParameterInfo &other) const |
| For some reason necessary, although trivial. | |
| Public Member Functions inherited from ml::Base | |
| Base () | |
| Constructor. | |
| virtual | ~Base () |
| Destructor. | |
| virtual Base * | deepCopy () const |
| bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
| virtual bool | isRefCountedBase () const |
| Returns whether the instance is derived from RefCountedBase. | |
| virtual std::string | detailString () const |
| virtual bool | implementsPersistence (PersistenceInterface) const |
| virtual std::string | persistentState () const |
| Returns a string describing the object's internal state. | |
| virtual void | setPersistentState (const std::string &state) |
| virtual void | addStateToTree (TreeNode *) const |
| Attaches the object state as children of the given parent node. | |
| virtual void | readStateFromTree (TreeNode *) |
| Reads the object state from the children of the given parent node. | |
| virtual void | writeTo (AbstractPersistenceOutputStream *) const |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
Public Attributes | |
| DataType | data |
| Use the public data member to interact with the contents, ParameterInfo is just the Base wrapper for it. | |
Detailed Description
We would normally co-derive from QVariantMap, but this turned out to cause at least linker problems down the line, so we just hold the data.
Definition at line 20 of file mlParameterInfo.h.
Member Typedef Documentation
◆ DataType
| typedef QVariantMap ml::ParameterInfo::DataType |
Definition at line 24 of file mlParameterInfo.h.
◆ KeyType
| typedef QString ml::ParameterInfo::KeyType |
Definition at line 25 of file mlParameterInfo.h.
◆ ValueType
| typedef QVariant ml::ParameterInfo::ValueType |
Definition at line 26 of file mlParameterInfo.h.
Constructor & Destructor Documentation
◆ ParameterInfo() [1/4]
|
default |
Referenced by operator==().
◆ ParameterInfo() [2/4]
|
explicit |
Allow initialization from a data object.
◆ ParameterInfo() [3/4]
| ml::ParameterInfo::ParameterInfo | ( | DataType && | otherData | ) |
Allow to move data on construction.
◆ ParameterInfo() [4/4]
| ml::ParameterInfo::ParameterInfo | ( | std::initializer_list< std::pair< KeyType, ValueType > > | listOfKeyValuePairs | ) |
For convenience, allow initialization via { { "key1", value1 }, { "key2", value2 }, ... }.
Member Function Documentation
◆ operator==()
| bool ml::ParameterInfo::operator== | ( | const ParameterInfo & | other | ) | const |
For some reason necessary, although trivial.
References ParameterInfo().
Member Data Documentation
◆ data
| DataType ml::ParameterInfo::data |
Use the public data member to interact with the contents, ParameterInfo is just the Base wrapper for it.
Definition at line 29 of file mlParameterInfo.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/ParameterInfo/MLParameterInfo/Sources/mlParameterInfo.h
