DcmUnsignedLong Class Reference

a class representing the DICOM value representation 'Unsigned Long' (UL) More...

Inheritance diagram for DcmUnsignedLong:

List of all members.

Public Member Functions
	DcmUnsignedLong (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmUnsignedLong (const DcmUnsignedLong &old)
	copy constructor
virtual	~DcmUnsignedLong ()
	destructor
DcmUnsignedLong &	operator= (const DcmUnsignedLong &obj)
	assignment operator
virtual DcmObject *	clone () const
	clone method
virtual DcmEVR	ident () const
	get element type identifier
virtual unsigned long	getVM ()
	get value multiplicity
virtual void	print (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	getUint32 (Uint32 &uintVal, const unsigned long pos=0)
	get particular integer value
virtual OFCondition	getUint32Array (Uint32 *&uintVals)
	get reference to stored integer data.
virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get particular value as a character string
virtual OFCondition	putUint32 (const Uint32 uintVal, const unsigned long pos=0)
	set particular element value to given integer
virtual OFCondition	putUint32Array (const Uint32 *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

---

Detailed Description

a class representing the DICOM value representation 'Unsigned Long' (UL)

Definition at line 45 of file dcvrul.h.

---

Constructor & Destructor Documentation

DcmUnsignedLong::DcmUnsignedLong (  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().

DcmUnsignedLong::DcmUnsignedLong (  const DcmUnsignedLong &  old  )

copy constructor Parameters: old  element to be copied

---

Member Function Documentation

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

clone method Returns: deep copy of this object Implements DcmObject. Reimplemented in DcmUnsignedLongOffset. Definition at line 77 of file dcvrul.h. References DcmUnsignedLong().

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

get particular value as a character string 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 DcmUnsignedLong::getUint32 (  Uint32 &  uintVal, const unsigned long  pos = 0 )  [virtual]

get particular integer value Parameters: uintVal  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 DcmUnsignedLong::getUint32Array (  Uint32 *&  uintVals  )  [virtual]

get reference to stored integer data. The number of entries can be determined by "getVM()". Parameters: uintVals  reference to result variable Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

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

get value multiplicity Returns: number of currently stored values Implements DcmObject.

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

get element type identifier Returns: type identifier of this class (EVR_UL) Implements DcmObject. Reimplemented in DcmUnsignedLongOffset.

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

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

virtual void DcmUnsignedLong::print (  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 numbers. 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 DcmUnsignedLong::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 numeric characters, e.g. "1\22\333\4444\55555\666666\7777777". Parameters: stringVal  input character string Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedLong::putUint32 (  const Uint32  uintVal, const unsigned long  pos = 0 )  [virtual]

set particular element value to given integer Parameters: uintVal  unsigned integer 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 DcmUnsignedLong::putUint32Array (  const Uint32 *  uintVals, const unsigned long  numUints )  [virtual]

set element value to given integer array data Parameters: uintVals  unsigned integer data to be set numUints  number of integer values to be set Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedLong::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. Reimplemented in DcmUnsignedLongOffset.

---

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

• dcmdata/include/dcmtk/dcmdata/dcvrul.h

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5