Implement an ImagePropertyExtension object which can be passed to the ML. More...
#include <mlDicomTreeImagePropertyExtension.h>
Public Member Functions | |
| DicomTreeImagePropertyExtension () | |
| Constructor. | |
| DicomTreeImagePropertyExtension (const DicomTreeImagePropertyExtension &origObj) | |
| Copy constructor. | |
| DicomTreeImagePropertyExtension (const DCMTree::Const_TreePtr &initDCMTree, const std::string &fileName) | |
| Convenience constructor. | |
| virtual | ~DicomTreeImagePropertyExtension () |
| Destructor. | |
| DicomTreeImagePropertyExtension & | operator= (const DicomTreeImagePropertyExtension &origObj) |
| Assignment operator. | |
| const std::string & | getFileName () const |
| Returns the filename from which the dicom tree was originally loaded. | |
| void | setFileName (const std::string &fileName) |
| Sets the filename that should be associated with the dicom tree. | |
| const DCMTree::Const_TreePtr & | getDicomTagTree () const |
| Return pointer to the shared DICOM tree object. | |
| void | setDicomTagTree (const DCMTree::Const_TreePtr &newTree) |
| Set new shared DICOM tree object. | |
| virtual bool | equals (const ImagePropertyExtension &imgPropExt) const |
| Equality operation. | |
| virtual ImagePropertyExtension * | createClone () const |
| Create a copy of this object. | |
| virtual std::string | getValueAsString () const |
| Return value of object as string. | |
| virtual MLErrorCode | setValueFromString (const std::string &str) |
| Set value of property from string value and return ML_RESULT_OK on success or another MLErrorCode on failure. | |
Detailed Description
Implement an ImagePropertyExtension object which can be passed to the ML.
Note that we use a shared pointer as member thus all copies of objects do not create copies of the DICOM tree but only use additional references. If the last shared pointer is destroyed it then deletes the DICOM tree.
Definition at line 45 of file mlDicomTreeImagePropertyExtension.h.
Constructor & Destructor Documentation
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | ) |
Constructor.
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | const DicomTreeImagePropertyExtension & | origObj | ) |
Copy constructor.
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | const DCMTree::Const_TreePtr & | initDCMTree, |
| const std::string & | fileName | ||
| ) |
Convenience constructor.
| virtual ml::DicomTreeImagePropertyExtension::~DicomTreeImagePropertyExtension | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual ImagePropertyExtension* ml::DicomTreeImagePropertyExtension::createClone | ( | ) | const [virtual] |
Create a copy of this object.
Implements ml::ImagePropertyExtension.
| virtual bool ml::DicomTreeImagePropertyExtension::equals | ( | const ImagePropertyExtension & | imgPropExt | ) | const [virtual] |
Equality operation.
Implements ml::ImagePropertyExtension.
| const DCMTree::Const_TreePtr& ml::DicomTreeImagePropertyExtension::getDicomTagTree | ( | ) | const |
Return pointer to the shared DICOM tree object.
| const std::string& ml::DicomTreeImagePropertyExtension::getFileName | ( | ) | const |
Returns the filename from which the dicom tree was originally loaded.
| virtual std::string ml::DicomTreeImagePropertyExtension::getValueAsString | ( | ) | const [virtual] |
Return value of object as string.
Implements ml::ImagePropertyExtension.
| DicomTreeImagePropertyExtension& ml::DicomTreeImagePropertyExtension::operator= | ( | const DicomTreeImagePropertyExtension & | origObj | ) |
Assignment operator.
| void ml::DicomTreeImagePropertyExtension::setDicomTagTree | ( | const DCMTree::Const_TreePtr & | newTree | ) |
Set new shared DICOM tree object.
| void ml::DicomTreeImagePropertyExtension::setFileName | ( | const std::string & | fileName | ) |
Sets the filename that should be associated with the dicom tree.
| virtual MLErrorCode ml::DicomTreeImagePropertyExtension::setValueFromString | ( | const std::string & | str | ) | [virtual] |
Set value of property from string value and return ML_RESULT_OK on success or another MLErrorCode on failure.
Implements ml::ImagePropertyExtension.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLDicomTreeImagePropertyExtension/mlDicomTreeImagePropertyExtension.h
