MeVisLab Toolbox Reference
ml::DcmDRTFixationDeviceSequenceInterface Class Reference

Class to provide access to DRTFixationDeviceSequence. More...

#include <mlDcmDRTFixationDeviceSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTFixationDeviceSequenceInterface ()
 DcmDRTFixationDeviceSequenceInterface (std::vector< DcmDRTFixationDeviceSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTFixationDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTFixationDeviceSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter) const
bool getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string parameter)
bool getFixationDeviceDescription (unsigned long idx, std::string &parameter) const
bool getFixationDeviceDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getFixationDeviceDescriptionTag () const
bool setFixationDeviceDescription (unsigned long idx, std::string parameter)
bool getFixationDeviceLabel (unsigned long idx, std::string &parameter) const
bool getFixationDeviceLabel (DCMTree::TreePtr item, std::string &parameter) const
std::string getFixationDeviceLabelTag () const
bool setFixationDeviceLabel (unsigned long idx, std::string parameter)
bool getFixationDevicePitchAngle (unsigned long idx, float &parameter) const
bool getFixationDevicePitchAngle (DCMTree::TreePtr item, float &parameter) const
std::string getFixationDevicePitchAngleTag () const
bool setFixationDevicePitchAngle (unsigned long idx, float parameter)
bool getFixationDevicePosition (unsigned long idx, std::string &parameter) const
bool getFixationDevicePosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getFixationDevicePositionTag () const
bool setFixationDevicePosition (unsigned long idx, std::string parameter)
bool getFixationDeviceRollAngle (unsigned long idx, float &parameter) const
bool getFixationDeviceRollAngle (DCMTree::TreePtr item, float &parameter) const
std::string getFixationDeviceRollAngleTag () const
bool setFixationDeviceRollAngle (unsigned long idx, float parameter)
bool getFixationDeviceType (unsigned long idx, std::string &parameter) const
bool getFixationDeviceType (DCMTree::TreePtr item, std::string &parameter) const
std::string getFixationDeviceTypeTag () const
bool setFixationDeviceType (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTFixationDeviceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTFixationDeviceSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTFixationDeviceSequenceInterface::Item getItem (const size_t idx) const
DcmDRTFixationDeviceSequenceInterface::Item & addItem ()
void addItem (DcmDRTFixationDeviceSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTFixationDeviceSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTFixationDeviceSequence.

Definition at line 43 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTFixationDeviceSequenceInterface() [1/3]

ml::DcmDRTFixationDeviceSequenceInterface::DcmDRTFixationDeviceSequenceInterface ( )
inline

Definition at line 108 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ DcmDRTFixationDeviceSequenceInterface() [2/3]

ml::DcmDRTFixationDeviceSequenceInterface::DcmDRTFixationDeviceSequenceInterface ( std::vector< DcmDRTFixationDeviceSequenceInterface::Item > dcmSequence)
inline

Default Constructor.

Definition at line 111 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ DcmDRTFixationDeviceSequenceInterface() [3/3]

ml::DcmDRTFixationDeviceSequenceInterface::DcmDRTFixationDeviceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq)
inline

Definition at line 113 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTFixationDeviceSequenceInterface()

virtual ml::DcmDRTFixationDeviceSequenceInterface::~DcmDRTFixationDeviceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTFixationDeviceSequenceInterface::Item & ml::DcmDRTFixationDeviceSequenceInterface::addItem ( )
inline

Adds a new item to the sequence

Returns
Return the new item which has been added to the sequence

Definition at line 200 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

void ml::DcmDRTFixationDeviceSequenceInterface::addItem ( DcmDRTFixationDeviceSequenceInterface::Item newItem)
inline

Definition at line 205 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getAccessoryCode ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getAccessoryCode() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getAccessoryCode ( unsigned long idx,
std::string & parameter ) const

◆ getAccessoryCodeTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getAccessoryCodeTag ( ) const
inline

Definition at line 125 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDeviceDescription() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFixationDeviceDescription() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceDescription ( unsigned long idx,
std::string & parameter ) const

◆ getFixationDeviceDescriptionTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceDescriptionTag ( ) const
inline

Definition at line 131 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDeviceLabel() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceLabel ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFixationDeviceLabel() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceLabel ( unsigned long idx,
std::string & parameter ) const

◆ getFixationDeviceLabelTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceLabelTag ( ) const
inline

Definition at line 137 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDevicePitchAngle() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePitchAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getFixationDevicePitchAngle() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePitchAngle ( unsigned long idx,
float & parameter ) const

◆ getFixationDevicePitchAngleTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePitchAngleTag ( ) const
inline

Definition at line 143 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDevicePosition() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFixationDevicePosition() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePosition ( unsigned long idx,
std::string & parameter ) const

◆ getFixationDevicePositionTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePositionTag ( ) const
inline

Definition at line 149 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDeviceRollAngle() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceRollAngle ( DCMTree::TreePtr item,
float & parameter ) const

◆ getFixationDeviceRollAngle() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceRollAngle ( unsigned long idx,
float & parameter ) const

◆ getFixationDeviceRollAngleTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceRollAngleTag ( ) const
inline

Definition at line 155 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getFixationDeviceType() [1/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFixationDeviceType() [2/2]

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceType ( unsigned long idx,
std::string & parameter ) const

◆ getFixationDeviceTypeTag()

std::string ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceTypeTag ( ) const
inline

Definition at line 161 of file mlDcmDRTFixationDeviceSequenceInterface.h.

◆ getItem()

DcmDRTFixationDeviceSequenceInterface::Item ml::DcmDRTFixationDeviceSequenceInterface::getItem ( const size_t idx) const
inline

Gets the item at the indicated position.

Returns
The requested item, an empty item when the position is invalid

Definition at line 191 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTFixationDeviceSequenceInterface::getNumberOfItems ( ) const
inline

Return number of items the internal sequence consists of.

Returns
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 185 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ getSequence()

std::vector< DcmDRTFixationDeviceSequenceInterface::Item > ml::DcmDRTFixationDeviceSequenceInterface::getSequence ( ) const
inline

Return the DRTFixationDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFixationDeviceSequence

Definition at line 173 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

Referenced by DRTFixationDeviceSequenceWrapper::DRTFixationDeviceSequenceWrapper(), and DRTFixationDeviceSequenceWrapper::operator=().

◆ hasSequence()

bool ml::DcmDRTFixationDeviceSequenceInterface::hasSequence ( ) const
inline

Check if the DRTFixationDeviceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTFixationDeviceSequenceInterface::insertItem ( const size_t idx)
inline

Insert an item at the indicated position

Returns
true is the insertion was successful, false if position is invalid

Definition at line 211 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTFixationDeviceSequenceInterface::removeItem ( const size_t idx)
inline

Removes the indicated item from the sequence

Returns
true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 223 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

◆ setAccessoryCode()

bool ml::DcmDRTFixationDeviceSequenceInterface::setAccessoryCode ( unsigned long idx,
std::string parameter )

◆ setFixationDeviceDescription()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDeviceDescription ( unsigned long idx,
std::string parameter )

◆ setFixationDeviceLabel()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDeviceLabel ( unsigned long idx,
std::string parameter )

◆ setFixationDevicePitchAngle()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDevicePitchAngle ( unsigned long idx,
float parameter )

◆ setFixationDevicePosition()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDevicePosition ( unsigned long idx,
std::string parameter )

◆ setFixationDeviceRollAngle()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDeviceRollAngle ( unsigned long idx,
float parameter )

◆ setFixationDeviceType()

bool ml::DcmDRTFixationDeviceSequenceInterface::setFixationDeviceType ( unsigned long idx,
std::string parameter )

◆ setSequence()

void ml::DcmDRTFixationDeviceSequenceInterface::setSequence ( std::vector< DcmDRTFixationDeviceSequenceInterface::Item > dcmSequence)
inline

Set the DRTFixationDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFixationDeviceSequence

Definition at line 167 of file mlDcmDRTFixationDeviceSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTFixationDeviceSequenceInterface::Item> ml::DcmDRTFixationDeviceSequenceInterface::_itemVec
protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTFixationDeviceSequenceInterface(), DcmDRTFixationDeviceSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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