DcmAttributeTag Class Reference

a class representing the DICOM value representation 'Attribute Tag' (AT) More...

Inheritance diagram for DcmAttributeTag:

DcmElement DcmObject List of all members.

Public Member Functions

 DcmAttributeTag (const DcmTag &tag, const Uint32 len=0)
 constructor.
 DcmAttributeTag (const DcmAttributeTag &old)
 copy constructor
virtual ~DcmAttributeTag ()
 destructor
DcmAttributeTagoperator= (const DcmAttributeTag &obj)
 assignment operator
virtual DcmObjectclone () const
 clone method
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
virtual DcmEVR ident () const
 get element type identifier
virtual OFCondition checkValue (const OFString &vm="1-n", const OFBool oldFormat=OFFalse)
 check whether stored value conforms to the VR and to the specified VM
virtual unsigned long getVM ()
 get value multiplicity
virtual void print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char *pixelFileName=NULL, size_t *pixelCounter=NULL)
 print element to a stream.
virtual OFCondition getTagVal (DcmTagKey &tagVal, const unsigned long pos=0)
 get particular tag value
virtual OFCondition getUint16Array (Uint16 *&uintVals)
 get reference to stored integer data.
virtual OFCondition getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
 get specified value as a character string.
virtual OFCondition putTagVal (const DcmTagKey &tagVal, const unsigned long pos=0)
 set particular tag value
virtual OFCondition putUint16Array (const Uint16 *uintVals, const unsigned long numUints)
 set element value to given integer array data.
virtual OFCondition putString (const char *stringVal)
 set element value from the given character string.
virtual OFCondition verify (const OFBool autocorrect=OFFalse)
 check the currently stored element value

Static Public Member Functions

static OFCondition checkStringValue (const OFString &value, const OFString &vm="1-n")
 check whether given string value conforms to the VR "AT" (Attribute Tag) and to the specified VM.

Detailed Description

a class representing the DICOM value representation 'Attribute Tag' (AT)

Definition at line 40 of file dcvrat.h.


Constructor & Destructor Documentation

DcmAttributeTag::DcmAttributeTag ( const DcmTag tag,
const Uint32  len = 0 
)

constructor.

Create new element from given tag and length.

Parameters:
tag DICOM tag for the new element
len value length for the new element

Referenced by clone().

DcmAttributeTag::DcmAttributeTag ( const DcmAttributeTag old  ) 

copy constructor

Parameters:
old element to be copied


Member Function Documentation

DcmAttributeTag& DcmAttributeTag::operator= ( const DcmAttributeTag obj  ) 

assignment operator

Parameters:
obj element to be assigned/copied
Returns:
reference to this object

virtual DcmObject* DcmAttributeTag::clone (  )  const [inline, virtual]

clone method

Returns:
deep copy of this object

Implements DcmObject.

Definition at line 72 of file dcvrat.h.

References DcmAttributeTag().

virtual OFCondition DcmAttributeTag::copyFrom ( const DcmObject rhs  )  [virtual]

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters:
rhs - [in] The instance to copy from. Has to be of the same class type as "this" object
Returns:
EC_Normal if copying was successful, error otherwise

Reimplemented from DcmElement.

virtual DcmEVR DcmAttributeTag::ident (  )  const [virtual]

get element type identifier

Returns:
type identifier of this class (EVR_AT)

Implements DcmObject.

virtual OFCondition DcmAttributeTag::checkValue ( const OFString vm = "1-n",
const OFBool  oldFormat = OFFalse 
) [virtual]

check whether stored value conforms to the VR and to the specified VM

Parameters:
vm value multiplicity (according to the data dictionary) to be checked for. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "9", "6", "16", "32")
oldFormat parameter not used for this VR (only for DA, TM, PN)
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise

Reimplemented from DcmElement.

virtual unsigned long DcmAttributeTag::getVM (  )  [virtual]

get value multiplicity

Returns:
number of tag value pairs (group,element)

Implements DcmObject.

virtual void DcmAttributeTag::print ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0,
const int  level = 0,
const char *  pixelFileName = NULL,
size_t *  pixelCounter = NULL 
) [virtual]

print element to a stream.

The output format of the value is a backslash separated sequence of group and element value pairs, e.g. "(0008,0020)\(0008,0030)"

Parameters:
out output stream
flags optional flag used to customize the output (see DCMTypes::PF_xxx)
level current level of nested items. Used for indentation.
pixelFileName not used
pixelCounter not used

Implements DcmObject.

virtual OFCondition DcmAttributeTag::getTagVal ( DcmTagKey tagVal,
const unsigned long  pos = 0 
) [virtual]

get particular tag value

Parameters:
tagVal reference to result variable (cleared in case of error)
pos index of the value to be retrieved (0..vm-1)
Returns:
status status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::getUint16Array ( Uint16 *&  uintVals  )  [virtual]

get reference to stored integer data.

The array entries with an even-numbered index contain the group numbers and the odd entries contain the element numbers (see "putUint16Array()"). The number of entries is twice as large as the return value of "getVM()".

Parameters:
uintVals reference to result variable
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::getOFString ( OFString stringVal,
const unsigned long  pos,
OFBool  normalize = OFTrue 
) [virtual]

get specified value as a character string.

The output format is "(gggg,eeee)" where "gggg" is the hexa-decimal group number and "eeee" the hexa-decimal element number of the attribute tag.

Parameters:
stringVal variable in which the result value is stored
pos index of the value in case of multi-valued elements (0..vm-1)
normalize not used
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::putTagVal ( const DcmTagKey tagVal,
const unsigned long  pos = 0 
) [virtual]

set particular tag value

Parameters:
tagVal tag value to be set
pos index of the value to be set (0 = first position)
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::putUint16Array ( const Uint16 *  uintVals,
const unsigned long  numUints 
) [virtual]

set element value to given integer array data.

The array entries with an even-numbered index are expected to contain the group numbers and the odd entries to contain the element numbers, e.g. {0x0008, 0x0020, 0x0008, 0x0030}. This function uses the same format as "getUint16Array()".

Parameters:
uintVals unsigned integer data to be set
numUints number of integer values to be set (should be even)
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::putString ( const char *  stringVal  )  [virtual]

set element value from the given character string.

The input string is expected to be a backslash separated sequence of attribute tags, e.g. "(0008,0020)\(0008,0030)". This is the same format as used by "print()".

Parameters:
stringVal input character string
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::verify ( const OFBool  autocorrect = OFFalse  )  [virtual]

check the currently stored element value

Parameters:
autocorrect correct value length if OFTrue
Returns:
status, EC_Normal if value length is correct, an error code otherwise

Implements DcmObject.

static OFCondition DcmAttributeTag::checkStringValue ( const OFString value,
const OFString vm = "1-n" 
) [static]

check whether given string value conforms to the VR "AT" (Attribute Tag) and to the specified VM.

Parameters:
value string value to be checked (possibly multi-valued)
vm value multiplicity (according to the data dictionary) to be checked for. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32")
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1