Base object class for passing DSRDocuments between MeVisLab modules. More...
#include <mlSRDocBase.h>
Public Member Functions | |
| SRDoc (std::string dcmFileName="", size_t flags=0, DCMTree::Const_TreePtr dcmTree=DCMTree::Const_TreePtr()) | |
| Constructor. | |
| ~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 |
| 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. | |
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()
|
override |
Destructor.
Member Function Documentation
◆ getSRDocumentIOD()
|
inline |
Get the SRDoc dcmtk object.
Definition at line 53 of file mlSRDocBase.h.
◆ isValid()
|
inline |
Return true if wrapped SRDocumentIOD object is valid.
Definition at line 56 of file mlSRDocBase.h.
References mlrange_cast().
◆ 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
