MeVisLab Toolbox Reference
Classes | Public Member Functions | Protected Attributes | List of all members
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)
 Set the DRTRecordedWedgeSequence this interface class provides access to.
 
std::vector< DcmDRTRecordedWedgeSequenceInterface::Item > getSequence () const
 Return the DRTRecordedWedgeSequence this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTRecordedWedgeSequence is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTRecordedWedgeSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTRecordedWedgeSequenceInterface::Item & addItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTRecordedWedgeSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position.
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence.
 

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.

◆ DcmDRTRecordedWedgeSequenceInterface() [3/3]

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

Definition at line 108 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ ~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.

◆ addItem() [2/2]

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

Definition at line 194 of file mlDcmDRTRecordedWedgeSequenceInterface.h.

◆ 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.

Referenced by DRTRecordedWedgeSequenceWrapper::getAccessoryCodeTag().

◆ 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.

◆ 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.

◆ 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.

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.

Referenced by DRTRecordedWedgeSequenceWrapper::getWedgeAngleTag().

◆ 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.

Referenced by DRTRecordedWedgeSequenceWrapper::getWedgeIDTag().

◆ 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.

Referenced by DRTRecordedWedgeSequenceWrapper::getWedgeNumberTag().

◆ 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.

Referenced by DRTRecordedWedgeSequenceWrapper::getWedgeOrientationTag().

◆ 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.

Referenced by DRTRecordedWedgeSequenceWrapper::getWedgeTypeTag().

◆ 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.

◆ 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.

◆ 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.

◆ 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.

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

◆ 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.

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