Base class from which one can derive own image properties. More...
#include <mlImagePropertyExtension.h>
Public Member Functions | |
| ImagePropertyExtension () | |
| Default constructor; does nothing. More... | |
| virtual | ~ImagePropertyExtension () |
| Destructor. More... | |
| virtual bool | equals (const ImagePropertyExtension &extImageProps) const =0 |
Returns true if this object equals extImageProps. More... | |
| virtual ImagePropertyExtension * | createClone () const =0 |
| Pure virtual method that must return a copy of the current object. More... | |
| virtual std::string | getValueAsString () const =0 |
| Returns the value of the object as string. More... | |
| virtual void | getValueAsString (std::string &valAsString) const |
| Returns the value of the object as string in valAsString. More... | |
| virtual MLErrorCode | setValueFromString (const std::string &stringValue)=0 |
Sets the value of a property from the string stringValue and returns ML_RESULT_OK on success or another MLErrorCode on failure. More... | |
| virtual bool | operator== (const ImagePropertyExtension &extImageProps) const |
| Implements the equality operator based on the equals method. More... | |
| virtual bool | operator!= (const ImagePropertyExtension &extImageProps) const |
| Implements the inequality operator based on the equals method. More... | |
Detailed Description
Base class from which one can derive own image properties.
Note that this class must implement cloning and stream outputs.
Definition at line 36 of file mlImagePropertyExtension.h.
Constructor & Destructor Documentation
◆ ImagePropertyExtension()
|
inline |
Default constructor; does nothing.
Definition at line 41 of file mlImagePropertyExtension.h.
◆ ~ImagePropertyExtension()
|
inlinevirtual |
Destructor.
Definition at line 46 of file mlImagePropertyExtension.h.
Member Function Documentation
◆ createClone()
|
pure virtual |
Pure virtual method that must return a copy of the current object.
It must be implemented because applications need to get copies from objects that are only managed via base class pointers.
Implemented in ml::DicomTreeImagePropertyExtension.
◆ equals()
|
pure virtual |
Returns true if this object equals extImageProps.
This method needs to be overridden by derived classes. In the overrridden method, extImageProps is typically cast to a pointer to the derived class after checking its runtime type.
Implemented in ml::DicomTreeImagePropertyExtension.
◆ getValueAsString() [1/2]
|
pure virtual |
Returns the value of the object as string.
Must be implemented, for example, because file formats need to store / load the state of a ImagePropertyExtension instance on/from disk.
Implemented in ml::DicomTreeImagePropertyExtension.
◆ getValueAsString() [2/2]
|
virtual |
Returns the value of the object as string in valAsString.
The default implementation uses getValueAsString() const. However, it can be reimplemented in derived classes to improve performance.
Reimplemented in ml::DicomTreeImagePropertyExtension.
◆ operator!=()
|
virtual |
Implements the inequality operator based on the equals method.
◆ operator==()
|
virtual |
Implements the equality operator based on the equals method.
◆ setValueFromString()
|
pure virtual |
Sets the value of a property from the string stringValue and returns ML_RESULT_OK on success or another MLErrorCode on failure.
Implemented in ml::DicomTreeImagePropertyExtension.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLUtilities/mlImagePropertyExtension.h
