MeVisLab Toolbox Reference
ml::DcmDRTModifiedAttributesSequenceInterface Class Reference

Class to provide access to DRTModifiedAttributesSequence. More...

#include <mlDcmDRTModifiedAttributesSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTModifiedAttributesSequenceInterface ()
 DcmDRTModifiedAttributesSequenceInterface (std::vector< DcmDRTModifiedAttributesSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTModifiedAttributesSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTModifiedAttributesSequenceInterface ()
 Default virtual Destructor.
void setSequence (std::vector< DcmDRTModifiedAttributesSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTModifiedAttributesSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTModifiedAttributesSequenceInterface::Item getItem (const size_t idx) const
DcmDRTModifiedAttributesSequenceInterface::Item & addItem ()
void addItem (DcmDRTModifiedAttributesSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTModifiedAttributesSequence.

Definition at line 43 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTModifiedAttributesSequenceInterface() [1/3]

ml::DcmDRTModifiedAttributesSequenceInterface::DcmDRTModifiedAttributesSequenceInterface ( )
inline

Definition at line 73 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

◆ DcmDRTModifiedAttributesSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 76 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ DcmDRTModifiedAttributesSequenceInterface() [3/3]

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

Definition at line 78 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTModifiedAttributesSequenceInterface()

virtual ml::DcmDRTModifiedAttributesSequenceInterface::~DcmDRTModifiedAttributesSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 86 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 123 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 128 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTModifiedAttributesSequenceInterface::Item ml::DcmDRTModifiedAttributesSequenceInterface::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 114 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTModifiedAttributesSequenceInterface::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 108 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTModifiedAttributesSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTModifiedAttributesSequence

Definition at line 96 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTModifiedAttributesSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 102 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTModifiedAttributesSequenceInterface::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 134 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTModifiedAttributesSequenceInterface::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 146 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

◆ setSequence()

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

Set the DRTModifiedAttributesSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTModifiedAttributesSequence

Definition at line 90 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 158 of file mlDcmDRTModifiedAttributesSequenceInterface.h.

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

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