Base object class for passing DSRDocuments between MeVisLab modules. More...

#include <mlSRDocBase.h>

Inheritance diagram for ml::SRDoc:

Public Member Functions
	SRDoc (std::string dcmFileName="", size_t flags=0, DCMTree::Const_TreePtr dcmTree=DCMTree::Const_TreePtr())
	~SRDoc () override
	Destructor.
void	setSRDocumentIOD (DSRDocumentPtr rtDosePtr)
	Set the SRDoc dcmtk object and collect all referenced dcmtk objects.
DSRDocumentPtr	getSRDocumentIOD ()
	Get the SRDoc dcmtk object.
bool	isValid ()
	Return true if wrapped SRDocumentIOD object is valid.
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
std::string	recentMessages
	Contains messages from the recent operation if there are any.

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 DSRDocuments between MeVisLab modules.

Definition at line 35 of file mlSRDocBase.h.

Constructor & Destructor Documentation

◆ SRDoc()

ml::SRDoc::SRDoc	(	std::string	dcmFileName = "",
		size_t	flags = 0,
		DCMTree::Const_TreePtr	dcmTree = DCMTree::Const_TreePtr() )

Constructor. Gets a reference to the name of the DICOM file containing the sr document object to be wrapped and flags passed to the document reader. (Error) messages are stored in recentMessages. For the large number of available flags check documentation in file dsrtypes.h of dcmtk and in dsrdoc.h of dcmtk.

◆ ~SRDoc()

ml::SRDoc::~SRDoc ( )

override

Destructor.

Member Function Documentation

◆ getSRDocumentIOD()

DSRDocumentPtr ml::SRDoc::getSRDocumentIOD ( )

inline

Get the SRDoc dcmtk object.

Definition at line 53 of file mlSRDocBase.h.

◆ isValid()

bool ml::SRDoc::isValid ( )

inline

Return true if wrapped SRDocumentIOD object is valid.

Definition at line 56 of file mlSRDocBase.h.

◆ setSRDocumentIOD()

void ml::SRDoc::setSRDocumentIOD ( DSRDocumentPtr rtDosePtr )

Set the SRDoc dcmtk object and collect all referenced dcmtk objects.

Member Data Documentation

◆ recentMessages

std::string ml::SRDoc::recentMessages

Contains messages from the recent operation if there are any.

Definition at line 59 of file mlSRDocBase.h.

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

FMEwork/ReleaseMeVis/Sources/ML/MLMultiFileVolumeListDcmtkOutputs/mlSRDocBase.h

Public Member Functions

Public Attributes

Additional Inherited Members