MeVisLab Toolbox Reference
ml::PresentationState Class Reference

Base object class for passing DVPresentationState objects between MeVisLab modules. More...

#include <mlPresentationStateBase.h>

Inheritance diagram for ml::PresentationState:
ml::Base

Public Member Functions

 PresentationState (const std::string &dcmFileName="", MultiFileVolumeList *mfvl=NULL)
 Constructor specifying the name of the DICOM file containing the PR document to be wrapped as well as optionally the MultiFileVolumeList in which this object lives. More...
 
DVPresentationStatePtr getDVPresentationStateIOD ()
 Get the PresentationState dcmtk object. More...
 
bool isValid ()
 Return true if wrapped PresentationStateumentIOD object is valid. More...
 
const MultiFileVolumeListgetMultiFileVolumeList ()
 Returns the associated MultiFileVolumeList in which this object lives or NULL if there is none. More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
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. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 

Additional Inherited Members

- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Detailed Description

Base object class for passing DVPresentationState objects between MeVisLab modules.

Definition at line 42 of file mlPresentationStateBase.h.

Constructor & Destructor Documentation

◆ PresentationState()

ml::PresentationState::PresentationState ( const std::string &  dcmFileName = "",
MultiFileVolumeList mfvl = NULL 
)

Constructor specifying the name of the DICOM file containing the PR document to be wrapped as well as optionally the MultiFileVolumeList in which this object lives.

Member Function Documentation

◆ getDVPresentationStateIOD()

DVPresentationStatePtr ml::PresentationState::getDVPresentationStateIOD ( )
inline

Get the PresentationState dcmtk object.

Definition at line 53 of file mlPresentationStateBase.h.

◆ getMultiFileVolumeList()

const MultiFileVolumeList* ml::PresentationState::getMultiFileVolumeList ( )

Returns the associated MultiFileVolumeList in which this object lives or NULL if there is none.

Might be useful to find associated and also imported DICOM files.

◆ isValid()

bool ml::PresentationState::isValid ( void  )
inline

Return true if wrapped PresentationStateumentIOD object is valid.

Definition at line 56 of file mlPresentationStateBase.h.


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