DcmFloatingPointSingle Class Reference

a class representing the DICOM value representation 'Floating Point Single' (FL) More...

Inheritance diagram for DcmFloatingPointSingle:

List of all members.

Public Member Functions
	DcmFloatingPointSingle (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmFloatingPointSingle (const DcmFloatingPointSingle &old)
	copy constructor
virtual	~DcmFloatingPointSingle ()
	destructor
DcmFloatingPointSingle &	operator= (const DcmFloatingPointSingle &obj)
	assignment operator
virtual DcmObject *	clone () const
	clone method
virtual DcmEVR	ident (void) 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	getFloat32 (Float32 &floatVal, const unsigned long pos=0)
	get particular float value
virtual OFCondition	getFloat32Array (Float32 *&floatVals)
	get reference to stored float data
virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get a particular value as a character string.
virtual OFCondition	putFloat32 (const Float32 floatVal, const unsigned long pos=0)
	set particular element value to given float
virtual OFCondition	putFloat32Array (const Float32 *floatVals, const unsigned long numFloats)
	set element value to given float 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 'Floating Point Single' (FL)

Definition at line 45 of file dcvrfl.h.

---

Constructor & Destructor Documentation

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

DcmFloatingPointSingle::DcmFloatingPointSingle (  const DcmFloatingPointSingle &  old  )

copy constructor Parameters: old  element to be copied

---

Member Function Documentation

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

clone method Returns: deep copy of this object Implements DcmObject. Reimplemented in DcmOtherFloat. Definition at line 77 of file dcvrfl.h. References DcmFloatingPointSingle().

virtual OFCondition DcmFloatingPointSingle::getFloat32 (  Float32 &  floatVal, const unsigned long  pos = 0 )  [virtual]

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

virtual OFCondition DcmFloatingPointSingle::getFloat32Array (  Float32 *&  floatVals  )  [virtual]

get reference to stored float data Parameters: floatVals  reference to result variable Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

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

get a particular value as a character string. The resulting string contains a variable number of digits as created by the OFStandard::ftoa() function by default. 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 unsigned long DcmFloatingPointSingle::getVM (   )  [virtual]

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

virtual DcmEVR DcmFloatingPointSingle::ident (  void   )  const [virtual]

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

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

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

virtual void DcmFloatingPointSingle::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. This function uses a variable number of digits for the floating point values as created by the OFStandard::ftoa() function by default. 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 DcmFloatingPointSingle::putFloat32 (  const Float32  floatVal, const unsigned long  pos = 0 )  [virtual]

set particular element value to given float Parameters: floatVal  floating point 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 DcmFloatingPointSingle::putFloat32Array (  const Float32 *  floatVals, const unsigned long  numFloats )  [virtual]

set element value to given float array data Parameters: floatVals  floating point data to be set numFloats  number of floating point values to be set Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

virtual OFCondition DcmFloatingPointSingle::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. "12.3456\1\-123.456\1234.0". Parameters: stringVal  input character string Returns: status, EC_Normal if successful, an error code otherwise Reimplemented from DcmElement.

virtual OFCondition DcmFloatingPointSingle::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.

---

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

• dcmdata/include/dcmtk/dcmdata/dcvrfl.h

---

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