ml::DcmDRTFixationDeviceSequenceInterface Class Reference

Class to provide access to DRTFixationDeviceSequence. More...

#include <mlDcmDRTFixationDeviceSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTFixationDeviceSequenceInterface (DRTFixationDeviceSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTFixationDeviceSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTFixationDeviceSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getFixationDeviceDescription (unsigned long idx, std::string &parameter)
bool getFixationDeviceDescription (DRTFixationDeviceSequence::Item &item, std::string &parameter)
std::string getFixationDeviceDescriptionTag () const
bool setFixationDeviceDescription (unsigned long idx, std::string &parameter)
bool getFixationDeviceLabel (unsigned long idx, std::string &parameter)
bool getFixationDeviceLabel (DRTFixationDeviceSequence::Item &item, std::string &parameter)
std::string getFixationDeviceLabelTag () const
bool setFixationDeviceLabel (unsigned long idx, std::string &parameter)
bool getFixationDevicePitchAngle (unsigned long idx, float &parameter)
bool getFixationDevicePitchAngle (DRTFixationDeviceSequence::Item &item, float &parameter)
std::string getFixationDevicePitchAngleTag () const
bool setFixationDevicePitchAngle (unsigned long idx, float &parameter)
bool getFixationDevicePosition (unsigned long idx, std::string &parameter)
bool getFixationDevicePosition (DRTFixationDeviceSequence::Item &item, std::string &parameter)
std::string getFixationDevicePositionTag () const
bool setFixationDevicePosition (unsigned long idx, std::string &parameter)
bool getFixationDeviceRollAngle (unsigned long idx, float &parameter)
bool getFixationDeviceRollAngle (DRTFixationDeviceSequence::Item &item, float &parameter)
std::string getFixationDeviceRollAngleTag () const
bool setFixationDeviceRollAngle (unsigned long idx, float &parameter)
bool getFixationDeviceType (unsigned long idx, std::string &parameter)
bool getFixationDeviceType (DRTFixationDeviceSequence::Item &item, std::string &parameter)
std::string getFixationDeviceTypeTag () const
bool setFixationDeviceType (unsigned long idx, std::string &parameter)
void setSequence (DRTFixationDeviceSequence *dcmSequence)
 Set the DRTFixationDeviceSequence this interface class provides access to.
DRTFixationDeviceSequence * getSequence () const
 Return the DRTFixationDeviceSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTFixationDeviceSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTFixationDeviceSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTFixationDeviceSequence::Item * addItem ()
 Return number of items the internal sequence consists of.
bool insertItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
bool removeItem (const unsigned long idx)
 Return number of items the internal sequence consists of.

Protected Attributes

DRTFixationDeviceSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTFixationDeviceSequence.

Definition at line 42 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTFixationDeviceSequenceInterface::DcmDRTFixationDeviceSequenceInterface ( DRTFixationDeviceSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTFixationDeviceSequenceInterface.h.

virtual ml::DcmDRTFixationDeviceSequenceInterface::~DcmDRTFixationDeviceSequenceInterface (  )  [inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Member Function Documentation

DRTFixationDeviceSequence::Item* ml::DcmDRTFixationDeviceSequenceInterface::addItem (  )  [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 131 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getAccessoryCode ( DRTFixationDeviceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceDescription ( DRTFixationDeviceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceLabel ( DRTFixationDeviceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePitchAngle ( DRTFixationDeviceSequence::Item &  item,
float &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDevicePosition ( DRTFixationDeviceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 77 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceRollAngle ( DRTFixationDeviceSequence::Item &  item,
float &  parameter 
)

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

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

Definition at line 83 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::getFixationDeviceType ( DRTFixationDeviceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 89 of file mlDcmDRTFixationDeviceSequenceInterface.h.

DRTFixationDeviceSequence::Item* ml::DcmDRTFixationDeviceSequenceInterface::getItem ( const unsigned long  idx  )  [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 122 of file mlDcmDRTFixationDeviceSequenceInterface.h.

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 113 of file mlDcmDRTFixationDeviceSequenceInterface.h.

DRTFixationDeviceSequence* ml::DcmDRTFixationDeviceSequenceInterface::getSequence (  )  const [inline]

Return the DRTFixationDeviceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTFixationDeviceSequence

Definition at line 101 of file mlDcmDRTFixationDeviceSequenceInterface.h.

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

Check if the DRTFixationDeviceSequence is set.

Returns:
True if internal pointer is set, False else.

Definition at line 107 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::insertItem ( const unsigned long  idx  )  [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 142 of file mlDcmDRTFixationDeviceSequenceInterface.h.

bool ml::DcmDRTFixationDeviceSequenceInterface::removeItem ( const unsigned long  idx  )  [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 153 of file mlDcmDRTFixationDeviceSequenceInterface.h.

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

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

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

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

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

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

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

void ml::DcmDRTFixationDeviceSequenceInterface::setSequence ( DRTFixationDeviceSequence *  dcmSequence  )  [inline]

Set the DRTFixationDeviceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTFixationDeviceSequence

Definition at line 95 of file mlDcmDRTFixationDeviceSequenceInterface.h.

Member Data Documentation

DRTFixationDeviceSequence* ml::DcmDRTFixationDeviceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 163 of file mlDcmDRTFixationDeviceSequenceInterface.h.

The documentation for this class was generated from the following file:
Generated on Sat Sep 3 18:39:45 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8