ml::ImagePropertyExtension Class Reference

Base class from which one can derive own image properties. More...

#include <mlImagePropertyExtension.h>

List of all members.

Public Member Functions
	ImagePropertyExtension ()
	Default constructor doing nothing.
virtual	~ImagePropertyExtension ()
	Destructor.
virtual bool	equals (const ImagePropertyExtension &extImageProps) const =0
	Returns true if this object equals extImageProps.
virtual ImagePropertyExtension *	createClone () const =0
	Pure virtual method which must return a copy of the current object.
virtual std::string	getValueAsString () const =0
	Returns the value of the object as string.
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.
virtual bool	operator== (const ImagePropertyExtension &extImageProps) const
	Implements equality operation based on the equals method.
virtual bool	operator!= (const ImagePropertyExtension &extImageProps) const
	Implements inequality operation based on the equals method.

---

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 29 of file mlImagePropertyExtension.h.

---

Constructor & Destructor Documentation

ml::ImagePropertyExtension::ImagePropertyExtension

(

)

[inline]

Default constructor doing nothing.

Definition at line 34 of file mlImagePropertyExtension.h.

References ML_TRACE_IN_TIME_CRITICAL.

virtual ml::ImagePropertyExtension::~ImagePropertyExtension

(

)

[inline, virtual]

Destructor.

Definition at line 40 of file mlImagePropertyExtension.h.

References ML_TRACE_IN_TIME_CRITICAL.

---

Member Function Documentation

virtual ImagePropertyExtension* ml::ImagePropertyExtension::createClone

(

)

const [pure virtual]

Pure virtual method which must return a copy of the current object.

It must be implemented because applications must be able to get copies from objects which are only managed via base class pointers.

virtual bool ml::ImagePropertyExtension::equals

(

const ImagePropertyExtension &

extImageProps

)

const [pure virtual]

Returns true if this object equals extImageProps.

This method needs to be overloaded by derived classes. In the overloaded method, extImageProps is typically casted to a pointer to the derived class after checking its runtime type.

virtual std::string ml::ImagePropertyExtension::getValueAsString

(

)

const [pure virtual]

Returns the value of the object as string.

Must be implemented for example because file formats must be able to store / load the state of a ImagePropertyExtension instance on/from disc.

virtual bool ml::ImagePropertyExtension::operator!=

(

const ImagePropertyExtension &

extImageProps

)

const [virtual]

Implements inequality operation based on the equals method.

virtual bool ml::ImagePropertyExtension::operator==

(

const ImagePropertyExtension &

extImageProps

)

const [virtual]

Implements equality operation based on the equals method.

virtual MLErrorCode ml::ImagePropertyExtension::setValueFromString

(

const std::string &

stringValue

)

[pure virtual]

Sets the value of a property from the string stringValue and returns ML_RESULT_OK on success or another MLErrorCode on failure.

---

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

• MeVis/Foundation/Sources/MLUtilities/mlImagePropertyExtension.h