209 lines
8.3 KiB
C
209 lines
8.3 KiB
C
|
/*
|
||
|
|
*
|
||
|
|
* Copyright (C) 1994-2014, OFFIS e.V.
|
||
|
|
* All rights reserved. See COPYRIGHT file for details.
|
||
|
|
*
|
||
|
|
* This software and supporting documentation were developed by
|
||
|
|
*
|
||
|
|
* OFFIS e.V.
|
||
|
|
* R&D Division Health
|
||
|
|
* Escherweg 2
|
||
|
|
* D-26121 Oldenburg, Germany
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* Module: dcmdata
|
||
|
|
*
|
||
|
|
* Author: Gerd Ehlers, Andreas Barth
|
||
|
|
*
|
||
|
|
* Purpose: Interface of class DcmFloatingPointSingle
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef DCVRFL_H
|
||
|
|
#define DCVRFL_H
|
||
|
|
|
||
|
|
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
|
||
|
|
|
||
|
|
#include "dcmtk/dcmdata/dcelem.h"
|
||
|
|
|
||
|
|
|
||
|
|
/** a class representing the DICOM value representation 'Floating Point Single' (FL)
|
||
|
|
*/
|
||
|
|
class DCMTK_DCMDATA_EXPORT DcmFloatingPointSingle
|
||
|
|
: public DcmElement
|
||
|
|
{
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
/** constructor.
|
||
|
|
* Create new element from given tag and length.
|
||
|
|
* @param tag DICOM tag for the new element
|
||
|
|
* @param len value length for the new element
|
||
|
|
*/
|
||
|
|
DcmFloatingPointSingle(const DcmTag &tag,
|
||
|
|
const Uint32 len = 0);
|
||
|
|
|
||
|
|
/** copy constructor
|
||
|
|
* @param old element to be copied
|
||
|
|
*/
|
||
|
|
DcmFloatingPointSingle(const DcmFloatingPointSingle &old);
|
||
|
|
|
||
|
|
/** destructor
|
||
|
|
*/
|
||
|
|
virtual ~DcmFloatingPointSingle();
|
||
|
|
|
||
|
|
/** assignment operator
|
||
|
|
* @param obj element to be assigned/copied
|
||
|
|
* @return reference to this object
|
||
|
|
*/
|
||
|
|
DcmFloatingPointSingle &operator=(const DcmFloatingPointSingle &obj);
|
||
|
|
|
||
|
|
/** comparison operator that compares the normalized value of this object
|
||
|
|
* with a given object of the same type. The tag of the element is also
|
||
|
|
* considered as the first component that is compared, followed by the
|
||
|
|
* object types (VR, i.e. DCMTK'S EVR) and the comparison of all value
|
||
|
|
* components of the object, preferrably in the order declared in the
|
||
|
|
* object (if applicable).
|
||
|
|
* @param rhs the right hand side of the comparison
|
||
|
|
* @return 0 if the object values are equal.
|
||
|
|
* -1 if either the value of the first component that does not match
|
||
|
|
* is lower in this object than in rhs, or all compared components match
|
||
|
|
* but this object has fewer components than rhs. Also returned if rhs
|
||
|
|
* cannot be casted to this object type.
|
||
|
|
* 1 if either the value of the first component that does not match
|
||
|
|
* is greater in this object than in rhs object, or all compared
|
||
|
|
* components match but the this component is longer.
|
||
|
|
*/
|
||
|
|
virtual int compare(const DcmElement& rhs) const;
|
||
|
|
|
||
|
|
/** clone method
|
||
|
|
* @return deep copy of this object
|
||
|
|
*/
|
||
|
|
virtual DcmObject *clone() const
|
||
|
|
{
|
||
|
|
return new DcmFloatingPointSingle(*this);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
* @param rhs - [in] The instance to copy from. Has to be of the same
|
||
|
|
* class type as "this" object
|
||
|
|
* @return EC_Normal if copying was successful, error otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition copyFrom(const DcmObject& rhs);
|
||
|
|
|
||
|
|
/** get element type identifier
|
||
|
|
* @return type identifier of this class (EVR_FL)
|
||
|
|
*/
|
||
|
|
virtual DcmEVR ident(void) const;
|
||
|
|
|
||
|
|
/** check whether stored value conforms to the VR and to the specified VM
|
||
|
|
* @param vm value multiplicity (according to the data dictionary) to be checked for.
|
||
|
|
* (See DcmElement::checkVM() for a list of valid values.)
|
||
|
|
* @param oldFormat parameter not used for this VR (only for DA, TM)
|
||
|
|
* @return status of the check, EC_Normal if value is correct, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition checkValue(const OFString &vm = "1-n",
|
||
|
|
const OFBool oldFormat = OFFalse);
|
||
|
|
|
||
|
|
/** get value multiplicity
|
||
|
|
* @return number of currently stored values
|
||
|
|
*/
|
||
|
|
virtual unsigned long getVM();
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
* @param out output stream
|
||
|
|
* @param flags optional flag used to customize the output (see DCMTypes::PF_xxx)
|
||
|
|
* @param level current level of nested items. Used for indentation.
|
||
|
|
* @param pixelFileName not used
|
||
|
|
* @param pixelCounter not used
|
||
|
|
*/
|
||
|
|
virtual void print(STD_NAMESPACE ostream&out,
|
||
|
|
const size_t flags = 0,
|
||
|
|
const int level = 0,
|
||
|
|
const char *pixelFileName = NULL,
|
||
|
|
size_t *pixelCounter = NULL);
|
||
|
|
|
||
|
|
/** get particular float value
|
||
|
|
* @param floatVal reference to result variable (cleared in case of error)
|
||
|
|
* @param pos index of the value to be retrieved (0..vm-1)
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition getFloat32(Float32 &floatVal,
|
||
|
|
const unsigned long pos = 0);
|
||
|
|
|
||
|
|
/** get reference to stored float data
|
||
|
|
* @param floatVals reference to result variable
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition getFloat32Array(Float32 *&floatVals);
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
* @param stringVal variable in which the result value is stored
|
||
|
|
* @param pos index of the value in case of multi-valued elements (0..vm-1)
|
||
|
|
* @param normalize not used
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition getOFString(OFString &stringVal,
|
||
|
|
const unsigned long pos,
|
||
|
|
OFBool normalize = OFTrue);
|
||
|
|
|
||
|
|
/** set particular element value to given float
|
||
|
|
* @param floatVal floating point value to be set
|
||
|
|
* @param pos index of the value to be set (0 = first position)
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition putFloat32(const Float32 floatVal,
|
||
|
|
const unsigned long pos = 0);
|
||
|
|
|
||
|
|
/** set element value to given float array data
|
||
|
|
* @param floatVals floating point data to be set
|
||
|
|
* @param numFloats number of floating point values to be set
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition putFloat32Array(const Float32 *floatVals,
|
||
|
|
const unsigned long numFloats);
|
||
|
|
|
||
|
|
/** 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".
|
||
|
|
* @param stringVal input character string
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition putString(const char *stringVal);
|
||
|
|
|
||
|
|
/** 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".
|
||
|
|
* The length of the string has to be specified explicitly. The string can, therefore,
|
||
|
|
* also contain more than one NULL byte.
|
||
|
|
* @param stringVal input character string
|
||
|
|
* @param stringLen length of the string (number of characters without the trailing
|
||
|
|
* NULL byte)
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition putString(const char *stringVal,
|
||
|
|
const Uint32 stringLen);
|
||
|
|
|
||
|
|
/** check the currently stored element value
|
||
|
|
* @param autocorrect correct value length if OFTrue
|
||
|
|
* @return status, EC_Normal if value length is correct, an error code otherwise
|
||
|
|
*/
|
||
|
|
virtual OFCondition verify(const OFBool autocorrect = OFFalse);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
#endif // DCVRFL_H
|