GDCM 3.0.24
Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
gdcm::CSAElement Class Reference

Class to represent a CSA Element. More...

#include <gdcmCSAElement.h>

Collaboration diagram for gdcm::CSAElement:
[legend]

Public Member Functions

 CSAElement (const CSAElement &_val)
 
 CSAElement (unsigned int kf=0)
 
const ByteValueGetByteValue () const
 
unsigned int GetKey () const
 Set/Get Key.
 
const char * GetName () const
 Set/Get Name.
 
unsigned int GetNoOfItems () const
 Set/Get NoOfItems.
 
unsigned int GetSyngoDT () const
 Set/Get SyngoDT.
 
ValueGetValue ()
 
Value const & GetValue () const
 Set/Get Value (bytes array, SQ of items, SQ of fragments):
 
const VMGetVM () const
 Set/Get VM.
 
VR const & GetVR () const
 Set/Get VR.
 
bool IsEmpty () const
 Check if CSA Element is empty.
 
bool operator< (const CSAElement &de) const
 
CSAElementoperator= (const CSAElement &de)=default
 
bool operator== (const CSAElement &de) const
 
void SetByteValue (const char *array, VL length)
 Set.
 
void SetKey (unsigned int key)
 
void SetName (const char *name)
 
void SetNoOfItems (unsigned int items)
 
void SetSyngoDT (unsigned int syngodt)
 
void SetValue (Value const &vl)
 
void SetVM (const VM &vm)
 
void SetVR (VR const &vr)
 

Protected Types

typedef SmartPointer< ValueDataPtr
 

Protected Attributes

DataPtr DataField
 
unsigned int KeyField
 
std::string NameField
 
unsigned int NoOfItemsField
 
unsigned int SyngoDTField
 
VM ValueMultiplicityField
 
VR VRField
 

Friends

std::ostream & operator<< (std::ostream &os, const CSAElement &val)
 

Detailed Description

Class to represent a CSA Element.

See also
CSAHeader
Examples
DumpCSA.cs, DumpSiemensBase64.cxx, MrProtocol.cxx, and csa2img.cxx.

Member Typedef Documentation

◆ DataPtr

Constructor & Destructor Documentation

◆ CSAElement() [1/2]

gdcm::CSAElement::CSAElement ( unsigned int  kf = 0)
inline

◆ CSAElement() [2/2]

gdcm::CSAElement::CSAElement ( const CSAElement _val)
inline

Member Function Documentation

◆ GetByteValue()

const ByteValue * gdcm::CSAElement::GetByteValue ( ) const
inline

Return the Value of CSAElement as a ByteValue (if possible)

Warning
: You need to check for NULL return value
Examples
DumpSiemensBase64.cxx, and MrProtocol.cxx.

◆ GetKey()

unsigned int gdcm::CSAElement::GetKey ( ) const
inline

Set/Get Key.

Referenced by operator<().

◆ GetName()

const char * gdcm::CSAElement::GetName ( ) const
inline

Set/Get Name.

◆ GetNoOfItems()

unsigned int gdcm::CSAElement::GetNoOfItems ( ) const
inline

Set/Get NoOfItems.

◆ GetSyngoDT()

unsigned int gdcm::CSAElement::GetSyngoDT ( ) const
inline

Set/Get SyngoDT.

◆ GetValue() [1/2]

Value & gdcm::CSAElement::GetValue ( )
inline

◆ GetValue() [2/2]

Value const & gdcm::CSAElement::GetValue ( ) const
inline

Set/Get Value (bytes array, SQ of items, SQ of fragments):

Examples
csa2img.cxx.

◆ GetVM()

const VM & gdcm::CSAElement::GetVM ( ) const
inline

Set/Get VM.

◆ GetVR()

VR const & gdcm::CSAElement::GetVR ( ) const
inline

Set/Get VR.

◆ IsEmpty()

bool gdcm::CSAElement::IsEmpty ( ) const
inline

Check if CSA Element is empty.

Examples
csa2img.cxx.

◆ operator<()

bool gdcm::CSAElement::operator< ( const CSAElement de) const
inline

References GetKey().

◆ operator=()

CSAElement & gdcm::CSAElement::operator= ( const CSAElement de)
default

◆ operator==()

bool gdcm::CSAElement::operator== ( const CSAElement de) const
inline

◆ SetByteValue()

void gdcm::CSAElement::SetByteValue ( const char *  array,
VL  length 
)
inline

Set.

◆ SetKey()

void gdcm::CSAElement::SetKey ( unsigned int  key)
inline

◆ SetName()

void gdcm::CSAElement::SetName ( const char *  name)
inline

◆ SetNoOfItems()

void gdcm::CSAElement::SetNoOfItems ( unsigned int  items)
inline

◆ SetSyngoDT()

void gdcm::CSAElement::SetSyngoDT ( unsigned int  syngodt)
inline

◆ SetValue()

void gdcm::CSAElement::SetValue ( Value const &  vl)
inline

◆ SetVM()

void gdcm::CSAElement::SetVM ( const VM vm)
inline

◆ SetVR()

void gdcm::CSAElement::SetVR ( VR const &  vr)
inline

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const CSAElement val 
)
friend

Member Data Documentation

◆ DataField

DataPtr gdcm::CSAElement::DataField
protected

◆ KeyField

unsigned int gdcm::CSAElement::KeyField
protected

Referenced by operator==().

◆ NameField

std::string gdcm::CSAElement::NameField
protected

Referenced by operator==().

◆ NoOfItemsField

unsigned int gdcm::CSAElement::NoOfItemsField
protected

◆ SyngoDTField

unsigned int gdcm::CSAElement::SyngoDTField
protected

Referenced by operator==().

◆ ValueMultiplicityField

VM gdcm::CSAElement::ValueMultiplicityField
protected

Referenced by operator==().

◆ VRField

VR gdcm::CSAElement::VRField
protected

Referenced by operator==().


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