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)
DVPresentationStatePtr getDVPresentationStateIOD ()
 Get the PresentationState dcmtk object.
bool isValid ()
 Return true if wrapped PresentationStateumentIOD object is valid.
const MultiFileVolumeListgetMultiFileVolumeList ()
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual BasedeepCopy () 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)

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

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.

Referenced by getMultiFileVolumeList().

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.

References PresentationState().

◆ isValid()

bool ml::PresentationState::isValid ( )
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: