gdcm::SequenceOfItems Class Reference

Class to represent a Sequence Of Items (value representation : SQ) More...

#include <gdcmSequenceOfItems.h>

Inheritance diagram for gdcm::SequenceOfItems:

Collaboration diagram for gdcm::SequenceOfItems:

List of all members.

Public Types
typedef ItemVector::const_iterator	ConstIterator
typedef std::vector< Item >	ItemVector
typedef ItemVector::iterator	Iterator
typedef ItemVector::size_type	SizeType
Public Member Functions
	SequenceOfItems ()
	constructor (UndefinedLength by default)
void	AddItem (Item const &item)
	Appends an Item to the already added ones.
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
template<typename TDE >
VL	ComputeLength () const
Iterator	End ()
ConstIterator	End () const
bool	FindDataElement (const Tag &t) const
const Item &	GetItem (SizeType position) const
Item &	GetItem (SizeType position)
VL	GetLength () const
	Returns the SQ length, as read from disk.
SizeType	GetNumberOfItems () const
bool	IsUndefinedLength () const
	return if Value Length if of undefined length
SequenceOfItems &	operator= (const SequenceOfItems &val)
bool	operator== (const Value &val) const
void	Print (std::ostream &os) const
template<typename TDE , typename TSwap >
std::istream &	Read (std::istream &is)
void	SetLength (VL length)
	Sets the actual SQ length.
void	SetLengthToUndefined ()
	Properly set the Sequence of Item to be undefined length.
void	SetNumberOfItems (SizeType n)
template<typename TDE , typename TSwap >
std::ostream const &	Write (std::ostream &os) const
Static Public Member Functions
static SmartPointer < SequenceOfItems >	New ()
Public Attributes
ItemVector	Items
	Vector of Sequence Items.
VL	SequenceLengthField
	Total length of the Sequence (or 0xffffffff) if undefined.

---

Detailed Description

Class to represent a Sequence Of Items (value representation : SQ)

• a Value Representation for Data Elements that contains a sequence of Data Sets.
• Sequence of Item allows for Nested Data Sets

See PS 3.5, 7.4.6 Data Element Type Within a Sequence

Note:

SEQUENCE OF ITEMS (VALUE REPRESENTATION SQ) A Value Representation for Data Elements that contain a sequence of Data Sets. Sequence of Items allows for Nested Data Sets.

Examples:

DumpGEMSMovieGroup.cxx, ExtractEncryptedContent.cxx, Extracting_All_Resolution.cxx, Fake_Image_Using_Stream_Image_Writer.cxx, GenAllVR.cxx, GenFakeIdentifyFile.cxx, GenLongSeqs.cxx, GenSeqs.cxx, GetSequenceUltrasound.cxx, and ReadExplicitLengthSQIVR.cxx.

---

Member Typedef Documentation

typedef ItemVector::const_iterator gdcm::SequenceOfItems::ConstIterator

typedef std::vector< Item > gdcm::SequenceOfItems::ItemVector

typedef ItemVector::iterator gdcm::SequenceOfItems::Iterator

typedef ItemVector::size_type gdcm::SequenceOfItems::SizeType

---

Constructor & Destructor Documentation

gdcm::SequenceOfItems::SequenceOfItems

(

)

[inline]

constructor (UndefinedLength by default)

---

Member Function Documentation

void gdcm::SequenceOfItems::AddItem

(

Item const &

item

)

Appends an Item to the already added ones.

Examples:

Extracting_All_Resolution.cxx, Fake_Image_Using_Stream_Image_Writer.cxx, GenAllVR.cxx, GenLongSeqs.cxx, and GenSeqs.cxx.

Iterator gdcm::SequenceOfItems::Begin

(

)

[inline]

ConstIterator gdcm::SequenceOfItems::Begin

(

)

const [inline]

void gdcm::SequenceOfItems::Clear

(

)

[inline, virtual]

Implements gdcm::Value.

template<typename TDE >

VL gdcm::SequenceOfItems::ComputeLength

(

)

const

Iterator gdcm::SequenceOfItems::End

(

)

[inline]

ConstIterator gdcm::SequenceOfItems::End

(

)

const [inline]

bool gdcm::SequenceOfItems::FindDataElement

(

const Tag &

t

)

const

const Item& gdcm::SequenceOfItems::GetItem

(

SizeType

position

)

const

Examples:

ChangeSequenceUltrasound.cxx, DumpGEMSMovieGroup.cxx, ExtractEncryptedContent.cxx, gdcmrtionplan.cxx, gdcmrtplan.cxx, GetSequenceUltrasound.cxx, LargeVRDSExplicit.cxx, and ReadAndDumpDICOMDIR.cxx.

Item& gdcm::SequenceOfItems::GetItem

(

SizeType

position

)

VL gdcm::SequenceOfItems::GetLength

(

)

const [inline, virtual]

Returns the SQ length, as read from disk.

Implements gdcm::Value.

SizeType gdcm::SequenceOfItems::GetNumberOfItems

(

)

const [inline]

Examples:

ChangeSequenceUltrasound.cxx, DumpGEMSMovieGroup.cxx, ExtractEncryptedContent.cxx, gdcmrtionplan.cxx, gdcmrtplan.cxx, GetSequenceUltrasound.cxx, and LargeVRDSExplicit.cxx.

bool gdcm::SequenceOfItems::IsUndefinedLength

(

)

const [inline]

return if Value Length if of undefined length

static SmartPointer<SequenceOfItems> gdcm::SequenceOfItems::New

(

)

[inline, static]

SequenceOfItems& gdcm::SequenceOfItems::operator=

(

const SequenceOfItems &

val

)

[inline]

References Items, and SequenceLengthField.

bool gdcm::SequenceOfItems::operator==

(

const Value &

val

)

const [inline, virtual]

Implements gdcm::Value.

References Items, and SequenceLengthField.

void gdcm::SequenceOfItems::Print

(

std::ostream &

os

)

const [inline, virtual]

Reimplemented from gdcm::Object.

template<typename TDE , typename TSwap >

std::istream& gdcm::SequenceOfItems::Read

(

std::istream &

is

)

[inline]

Examples:

ReadExplicitLengthSQIVR.cxx.

References gdcm::Item::Clear(), gdcmDebugMacro, gdcmWarningMacro, gdcm::Exception::GetDescription(), gdcm::Item::GetNestedDataSet(), gdcm::DataElement::GetTag(), gdcm::DataElement::GetVL(), gdcm::Item::Read(), and gdcm::DataSet::Size().

void gdcm::SequenceOfItems::SetLength

(

VL

length

)

[inline, virtual]

Sets the actual SQ length.

Implements gdcm::Value.

Examples:

ReadExplicitLengthSQIVR.cxx.

void gdcm::SequenceOfItems::SetLengthToUndefined

(

)

Properly set the Sequence of Item to be undefined length.

Examples:

Extracting_All_Resolution.cxx, Fake_Image_Using_Stream_Image_Writer.cxx, GenAllVR.cxx, GenLongSeqs.cxx, and GenSeqs.cxx.

void gdcm::SequenceOfItems::SetNumberOfItems

(

SizeType

n

)

[inline]

template<typename TDE , typename TSwap >

std::ostream const& gdcm::SequenceOfItems::Write

(

std::ostream &

os

)

const [inline]

References gdcm::VL::Write(), and gdcm::Tag::Write().

---

Member Data Documentation

ItemVector gdcm::SequenceOfItems::Items

Vector of Sequence Items.

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

VL gdcm::SequenceOfItems::SequenceLengthField

Total length of the Sequence (or 0xffffffff) if undefined.

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

---

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

• gdcmSequenceOfItems.h