ml::DicomTreeImagePropertyExtension Class Reference

#include <mlDicomTreeImagePropertyExtension.h>

Inheritance diagram for ml::DicomTreeImagePropertyExtension:

Public Member Functions
	DicomTreeImagePropertyExtension ()
	Constructor.
	DicomTreeImagePropertyExtension (const DicomTreeImagePropertyExtension &origObj)
	Copy constructor.
	DicomTreeImagePropertyExtension (const DCMTree::Const_TreePtr &initDCMTree, const std::string &fileName)
	Convenience constructor.
	~DicomTreeImagePropertyExtension () override
	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
	Returns a pointer to the shared DICOM tree object.
void	setDicomTagTree (const DCMTree::Const_TreePtr &newTree)
	Sets new shared DICOM tree object.
bool	equals (const ImagePropertyExtension &imgPropExt) const override
	Equality operation.
ImagePropertyExtension *	createClone () const override
	Creates a copy of this object.
std::string	getValueAsString () const override
	Returns the value of this object as string.
void	getValueAsString (std::string &valueAsString) const override
	Alternative version to return the object as string, which can be faster and less memory intensive on large created strings.
MLErrorCode	setValueFromString (const std::string &str) override
Public Member Functions inherited from ml::ImagePropertyExtension
	ImagePropertyExtension ()
	Default constructor; does nothing.
virtual	~ImagePropertyExtension ()
	Destructor.
virtual bool	operator== (const ImagePropertyExtension &extImageProps) const
	Implements the equality operator based on the equals method.
virtual bool	operator!= (const ImagePropertyExtension &extImageProps) const
	Implements the inequality operator based on the equals method.

Detailed Description

Implements an ImagePropertyExtension object that 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.

Referenced by DicomTreeImagePropertyExtension(), operator=(), and setValueFromString().

DicomTreeImagePropertyExtension() [2/3]

ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension

(

const DicomTreeImagePropertyExtension &

origObj

)

Copy constructor.

References DicomTreeImagePropertyExtension().

DicomTreeImagePropertyExtension() [3/3]

ml::DicomTreeImagePropertyExtension::DicomTreeImagePropertyExtension	(	const DCMTree::Const_TreePtr &	initDCMTree,
		const std::string &	fileName )

Convenience constructor.

~DicomTreeImagePropertyExtension()

ml::DicomTreeImagePropertyExtension::~DicomTreeImagePropertyExtension ( )

override

Destructor.

Member Function Documentation

createClone()

ImagePropertyExtension * ml::DicomTreeImagePropertyExtension::createClone ( ) const

overridevirtual

Creates a copy of this object.

Implements ml::ImagePropertyExtension.

References ml::ImagePropertyExtension::ImagePropertyExtension().

equals()

bool ml::DicomTreeImagePropertyExtension::equals ( const ImagePropertyExtension & imgPropExt ) const

overridevirtual

Equality operation.

Implements ml::ImagePropertyExtension.

References ml::ImagePropertyExtension::ImagePropertyExtension().

getDicomTagTree()

const DCMTree::Const_TreePtr & ml::DicomTreeImagePropertyExtension::getDicomTagTree

(

)

const

Returns a 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]

std::string ml::DicomTreeImagePropertyExtension::getValueAsString ( ) const

overridevirtual

Returns the value of this object as string.

Implements ml::ImagePropertyExtension.

getValueAsString() [2/2]

void ml::DicomTreeImagePropertyExtension::getValueAsString ( std::string & valueAsString ) const

overridevirtual

Alternative version to return 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.

References DicomTreeImagePropertyExtension().

setDicomTagTree()

void ml::DicomTreeImagePropertyExtension::setDicomTagTree

(

const DCMTree::Const_TreePtr &

newTree

)

Sets 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()

MLErrorCode ml::DicomTreeImagePropertyExtension::setValueFromString ( const std::string & str )

overridevirtual

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

Implements ml::ImagePropertyExtension.

References DicomTreeImagePropertyExtension().

---

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

• MeVis/Foundation/Sources/MLDicomTreeImagePropertyExtension/mlDicomTreeImagePropertyExtension.h