MeVisLab Toolbox Reference
ml::BaseWithParameterInfo Class Referenceabstract

Mixin class to support generic getParameterInfo() object wrapping of supporting classes (e.g. More...

#include <mlParameterInfo.h>

Inheritance diagram for ml::BaseWithParameterInfo:
ml::Base

Public Member Functions

ParameterInfo getParameterInfo () const
 Get parameter info. Redirects to _getParameterInfo()
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
 
virtual ~Base ()
 Destructor.
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion()
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument.
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase.
 
virtual std::string detailString () const
 Return a string describing this object.
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class.
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state.
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState().
 
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
 Write the objects state to the data stream object.
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object.
 

Additional Inherited Members

- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 

Detailed Description

Mixin class to support generic getParameterInfo() object wrapping of supporting classes (e.g.

for inspection in the MeVisLab Output Inspector)

Definition at line 51 of file mlParameterInfo.h.

Member Function Documentation

◆ getParameterInfo()

ParameterInfo ml::BaseWithParameterInfo::getParameterInfo ( ) const

Get parameter info. Redirects to _getParameterInfo()


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