MeVisLab Toolbox Reference
ml::DcmDRTRecordedWedgeSequenceInterface Class Reference

Class to provide access to DRTRecordedWedgeSequence. More...

#include <mlDcmDRTRecordedWedgeSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTRecordedWedgeSequenceInterface ()
 DcmDRTRecordedWedgeSequenceInterface (std::vector< DcmDRTRecordedWedgeSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTRecordedWedgeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTRecordedWedgeSequenceInterface ()
 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 getWedgeAngle (unsigned long idx, std::string &parameter) const
bool getWedgeAngle (DCMTree::TreePtr item, std::string &parameter) const
std::string getWedgeAngleTag () const
bool setWedgeAngle (unsigned long idx, std::string parameter)
bool getWedgeID (unsigned long idx, std::string &parameter) const
bool getWedgeID (DCMTree::TreePtr item, std::string &parameter) const
std::string getWedgeIDTag () const
bool setWedgeID (unsigned long idx, std::string parameter)
bool getWedgeNumber (unsigned long idx, std::string &parameter) const
bool getWedgeNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getWedgeNumberTag () const
bool setWedgeNumber (unsigned long idx, std::string parameter)
bool getWedgeOrientation (unsigned long idx, std::string &parameter) const
bool getWedgeOrientation (DCMTree::TreePtr item, std::string &parameter) const
std::string getWedgeOrientationTag () const
bool setWedgeOrientation (unsigned long idx, std::string parameter)
bool getWedgeType (unsigned long idx, std::string &parameter) const
bool getWedgeType (DCMTree::TreePtr item, std::string &parameter) const
std::string getWedgeTypeTag () const
bool setWedgeType (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTRecordedWedgeSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRecordedWedgeSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTRecordedWedgeSequenceInterface::Item getItem (const size_t idx) const
DcmDRTRecordedWedgeSequenceInterface::Item & addItem ()
void addItem (DcmDRTRecordedWedgeSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTRecordedWedgeSequence.

Definition at line 43 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRecordedWedgeSequenceInterface() [1/3]

ml::DcmDRTRecordedWedgeSequenceInterface::DcmDRTRecordedWedgeSequenceInterface ( )
inline

Definition at line 103 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ DcmDRTRecordedWedgeSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 106 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ DcmDRTRecordedWedgeSequenceInterface() [3/3]

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

Definition at line 108 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTRecordedWedgeSequenceInterface()

virtual ml::DcmDRTRecordedWedgeSequenceInterface::~DcmDRTRecordedWedgeSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 116 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 189 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 194 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

Definition at line 120 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ getItem()

DcmDRTRecordedWedgeSequenceInterface::Item ml::DcmDRTRecordedWedgeSequenceInterface::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 180 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTRecordedWedgeSequenceInterface::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 174 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTRecordedWedgeSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedWedgeSequence

Definition at line 162 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

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

◆ getWedgeAngle() [1/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeAngle ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getWedgeAngle() [2/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeAngle ( unsigned long idx,
std::string & parameter ) const

◆ getWedgeAngleTag()

std::string ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeAngleTag ( ) const
inline

Definition at line 126 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ getWedgeID() [1/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getWedgeID() [2/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeID ( unsigned long idx,
std::string & parameter ) const

◆ getWedgeIDTag()

std::string ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeIDTag ( ) const
inline

Definition at line 132 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ getWedgeNumber() [1/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getWedgeNumber() [2/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeNumber ( unsigned long idx,
std::string & parameter ) const

◆ getWedgeNumberTag()

std::string ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeNumberTag ( ) const
inline

Definition at line 138 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ getWedgeOrientation() [1/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeOrientation ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getWedgeOrientation() [2/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeOrientation ( unsigned long idx,
std::string & parameter ) const

◆ getWedgeOrientationTag()

std::string ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeOrientationTag ( ) const
inline

Definition at line 144 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ getWedgeType() [1/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getWedgeType() [2/2]

bool ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeType ( unsigned long idx,
std::string & parameter ) const

◆ getWedgeTypeTag()

std::string ml::DcmDRTRecordedWedgeSequenceInterface::getWedgeTypeTag ( ) const
inline

Definition at line 150 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTRecordedWedgeSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 168 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTRecordedWedgeSequenceInterface::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 200 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTRecordedWedgeSequenceInterface::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 212 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ setAccessoryCode()

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

◆ setSequence()

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

Set the DRTRecordedWedgeSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedWedgeSequence

Definition at line 156 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

References _itemVec.

◆ setWedgeAngle()

bool ml::DcmDRTRecordedWedgeSequenceInterface::setWedgeAngle ( unsigned long idx,
std::string parameter )

◆ setWedgeID()

bool ml::DcmDRTRecordedWedgeSequenceInterface::setWedgeID ( unsigned long idx,
std::string parameter )

◆ setWedgeNumber()

bool ml::DcmDRTRecordedWedgeSequenceInterface::setWedgeNumber ( unsigned long idx,
std::string parameter )

◆ setWedgeOrientation()

bool ml::DcmDRTRecordedWedgeSequenceInterface::setWedgeOrientation ( unsigned long idx,
std::string parameter )

◆ setWedgeType()

bool ml::DcmDRTRecordedWedgeSequenceInterface::setWedgeType ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 224 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

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

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