DcmFloatingPointSingle Class Reference

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

Inheritance diagram for DcmFloatingPointSingle:

DcmElement DcmObject DcmOtherFloat 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
DcmFloatingPointSingleoperator= (const DcmFloatingPointSingle &obj)
 assignment operator
virtual DcmObjectclone () const
 clone method
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
virtual DcmEVR ident (void) 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 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 40 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

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

assignment operator

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

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

clone method

Returns:
deep copy of this object

Implements DcmObject.

Reimplemented in DcmOtherFloat.

Definition at line 72 of file dcvrfl.h.

References DcmFloatingPointSingle().

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

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.

virtual OFCondition DcmFloatingPointSingle::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", "6", "9", "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.

Reimplemented in DcmOtherFloat.

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

get value multiplicity

Returns:
number of currently stored values

Implements DcmObject.

Reimplemented in DcmOtherFloat.

virtual void DcmFloatingPointSingle::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 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::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 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:


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