Implement an ImagePropertyExtension object which can be passed to the ML. More...
#include <mlDicomTreeImagePropertyExtension.h>
Public Member Functions | |
| DicomTreeImagePropertyExtension () | |
| Constructor. More... | |
| DicomTreeImagePropertyExtension (const DicomTreeImagePropertyExtension &origObj) | |
| Copy constructor. More... | |
| DicomTreeImagePropertyExtension (const DCMTree::Const_TreePtr &initDCMTree, const std::string &fileName) | |
| Convenience constructor. More... | |
| ~DicomTreeImagePropertyExtension () override | |
| Destructor. More... | |
| DicomTreeImagePropertyExtension & | operator= (const DicomTreeImagePropertyExtension &origObj) |
| Assignment operator. More... | |
| const std::string & | getFileName () const |
| Returns the filename from which the dicom tree was originally loaded. More... | |
| void | setFileName (const std::string &fileName) |
| Sets the filename that should be associated with the dicom tree. More... | |
| const DCMTree::Const_TreePtr & | getDicomTagTree () const |
| Return pointer to the shared DICOM tree object. More... | |
| void | setDicomTagTree (const DCMTree::Const_TreePtr &newTree) |
| Set new shared DICOM tree object. More... | |
| bool | equals (const ImagePropertyExtension &imgPropExt) const override |
| Equality operation. More... | |
| ImagePropertyExtension * | createClone () const override |
| Create a copy of this object. More... | |
| std::string | getValueAsString () const override |
| Return value of object as string. More... | |
| void | getValueAsString (std::string &valueAsString) const override |
| Alternative version to get the object as string which can be faster and less memory intensive on large created strings. More... | |
| MLErrorCode | setValueFromString (const std::string &str) override |
| Set value of property from string value and return ML_RESULT_OK on success or another MLErrorCode on failure. More... | |
 Public Member Functions inherited from ml::ImagePropertyExtension | |
| ImagePropertyExtension () | |
| Default constructor doing nothing. More... | |
| virtual | ~ImagePropertyExtension () |
| Destructor. More... | |
| virtual bool | operator== (const ImagePropertyExtension &extImageProps) const |
| Implements equality operation based on the equals method. More... | |
| virtual bool | operator!= (const ImagePropertyExtension &extImageProps) const |
| Implements inequality operation based on the equals method. More... | |
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 43 of file mlDicomTreeImagePropertyExtension.h.
Constructor & Destructor Documentation
◆ DicomTreeImagePropertyExtension() [1/3]
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | ) |
Constructor.
◆ DicomTreeImagePropertyExtension() [2/3]
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | const DicomTreeImagePropertyExtension & | origObj | ) |
Copy constructor.
◆ DicomTreeImagePropertyExtension() [3/3]
| ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension | ( | const DCMTree::Const_TreePtr & | initDCMTree, |
| const std::string & | fileName | ||
| ) |
Convenience constructor.
◆ ~DicomTreeImagePropertyExtension()
|
override |
Destructor.
Member Function Documentation
◆ createClone()
|
overridevirtual |
Create a copy of this object.
Implements ml::ImagePropertyExtension.
◆ equals()
|
overridevirtual |
Equality operation.
Implements ml::ImagePropertyExtension.
◆ getDicomTagTree()
| const DCMTree::Const_TreePtr& ml::DicomTreeImagePropertyExtension::getDicomTagTree | ( | ) | const |
Return pointer to the shared DICOM tree object.
◆ getFileName()
| const std::string& ml::DicomTreeImagePropertyExtension::getFileName | ( | ) | const |
Returns the filename from which the dicom tree was originally loaded.
◆ getValueAsString() [1/2]
|
overridevirtual |
Return value of object as string.
Implements ml::ImagePropertyExtension.
◆ getValueAsString() [2/2]
|
overridevirtual |
Alternative version to get the object as string which can be faster and less memory intensive on large created strings.
Reimplemented from ml::ImagePropertyExtension.
◆ operator=()
| DicomTreeImagePropertyExtension& ml::DicomTreeImagePropertyExtension::operator= | ( | const DicomTreeImagePropertyExtension & | origObj | ) |
Assignment operator.
◆ setDicomTagTree()
| void ml::DicomTreeImagePropertyExtension::setDicomTagTree | ( | const DCMTree::Const_TreePtr & | newTree | ) |
Set new shared DICOM tree object.
◆ setFileName()
| void ml::DicomTreeImagePropertyExtension::setFileName | ( | const std::string & | fileName | ) |
Sets the filename that should be associated with the dicom tree.
◆ setValueFromString()
|
overridevirtual |
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
