Class managing a multi-frame Z, T, and U-dimension plus a string value. More...

#include <mlZTUIndex.h>

Public Member Functions
	ZTUIndex (MLuint64 zp=0, MLuint64 tp=0, MLuint64 up=0, const std::string &val="")
	Convenience constructor. More...

	ZTUIndex (const std::string &val)
	Convenience constructor setting members from string with readMembersFromString. More...

bool	operator== (const ZTUIndex &a) const
	Equality operator. More...

bool	operator!= (const ZTUIndex &a) const
	Inequality operator. More...

bool	operator< (const ZTUIndex &a) const
	Artificial comparison operator on z,t, and u to be able to insert it into a map: u comparison is strongest, then t and smallest is z, the value component is not regarded. More...

bool	readMembersFromString (const std::string &srcVal)
	Reads a string of type "Z T U:Value" into the members and returns true on success, otherwise false. More...

bool	isInUINT32Range () const
	Returns true if z, t, and u are smaller or equal than ML_UINT32_MAX, otherwise false. More...

bool	isInSize_TRange () const
	Returns true if z, t, and u are smaller or equal than the currently compiled range of the size_t data type, otherwise false. More...

Public Attributes
MLuint64	z
	z-Coordinate of the frame. More...

MLuint64	t
	t-Coordinate of the frame. More...

MLuint64	u
	u-Coordinate of the frame. More...

std::string	value
	A string value assigned to the coordinate. More...

Detailed Description

Class managing a multi-frame Z, T, and U-dimension plus a string value.

Definition at line 26 of file mlZTUIndex.h.

Constructor & Destructor Documentation

◆ ZTUIndex() [1/2]

ml::DICOMTagTools::ZTUIndex::ZTUIndex	(	MLuint64	zp = `0`,
		MLuint64	tp = `0`,
		MLuint64	up = `0`,
		const std::string &	val = `""`
	)

Convenience constructor.

◆ ZTUIndex() [2/2]

ml::DICOMTagTools::ZTUIndex::ZTUIndex ( const std::string & val )

Convenience constructor setting members from string with readMembersFromString.

Member Function Documentation

◆ isInSize_TRange()

bool ml::DICOMTagTools::ZTUIndex::isInSize_TRange ( ) const

Returns true if z, t, and u are smaller or equal than the currently compiled range of the size_t data type, otherwise false.

◆ isInUINT32Range()

bool ml::DICOMTagTools::ZTUIndex::isInUINT32Range ( ) const

Returns true if z, t, and u are smaller or equal than ML_UINT32_MAX, otherwise false.

◆ operator!=()

bool ml::DICOMTagTools::ZTUIndex::operator!= ( const ZTUIndex & a ) const

Inequality operator.

◆ operator<()

bool ml::DICOMTagTools::ZTUIndex::operator< ( const ZTUIndex & a ) const

Artificial comparison operator on z,t, and u to be able to insert it into a map: u comparison is strongest, then t and smallest is z, the value component is not regarded.

For example (z=3,t=0,u=2) is smaller than (z=1,t=0,u=3).

◆ operator==()

bool ml::DICOMTagTools::ZTUIndex::operator== ( const ZTUIndex & a ) const

Equality operator.

◆ readMembersFromString()

bool ml::DICOMTagTools::ZTUIndex::readMembersFromString ( const std::string & srcVal )

Reads a string of type "Z T U:Value" into the members and returns true on success, otherwise false.

The "Value" part of the read string is either terminated by std::eof or std::endl. Therefore it can contain whitespaces. Since line terminators are platform dependent it is recommended not to rely on the endline terminators and provide srcVal strings which are not longer than the "Value" part.

Member Data Documentation

◆ t

MLuint64 ml::DICOMTagTools::ZTUIndex::t

t-Coordinate of the frame.

Definition at line 61 of file mlZTUIndex.h.

◆ u

MLuint64 ml::DICOMTagTools::ZTUIndex::u

u-Coordinate of the frame.

Definition at line 62 of file mlZTUIndex.h.

◆ value

std::string ml::DICOMTagTools::ZTUIndex::value

A string value assigned to the coordinate.

Definition at line 63 of file mlZTUIndex.h.

◆ z

MLuint64 ml::DICOMTagTools::ZTUIndex::z

z-Coordinate of the frame.

Definition at line 60 of file mlZTUIndex.h.

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDICOMTags/Sources/mlZTUIndex.h

Public Member Functions

Public Attributes