DCMTK  Version 3.6.4
OFFIS DICOM Toolkit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
TrcMeasurement::Values Class Reference

Class that holds actual measurement values. More...

+ Inheritance diagram for TrcMeasurement::Values:

Public Member Functions

virtual OFCondition get (const Float32 *&dataValues, unsigned long &numValues, const Uint32 *&trackPointIndices)
 Get measurement values and the point indices (if applicable) More...
 
virtual ~Values ()
 Destructor, frees memory.
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of component. More...
 
- Public Member Functions inherited from IODComponent
 IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor. More...
 
 IODComponent (IODComponent *parent=NULL)
 Constructor, creates rules and item from scratch. More...
 
IODComponentoperator= (const IODComponent &rhs)
 Assignment operator, copies contained item and rule set from rhs to "this" attribute set. More...
 
 IODComponent (const IODComponent &rhs)
 Copy constructor, copies reference to contained item and rule set to "this" attribute set. More...
 
virtual ~IODComponent ()
 Virtual Destructor.
 
void clearData ()
 Clear all attributes from the data that are handled by this module. More...
 
virtual void inventMissing ()
 Set missing values by inventing "default values". More...
 
OFshared_ptr< IODRulesgetRules ()
 Get rules handled by this module. More...
 
virtual void makeOptional ()
 Make component optional by turning all attributes requirement types of it to type 3. More...
 
DcmItemgetData ()
 Get the data handled by this module. More...
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read attributes from given item into this class. More...
 
virtual OFCondition write (DcmItem &destination)
 Write attributes from this class into given item. More...
 
virtual OFCondition check (const OFBool quiet=OFFalse)
 Check whether this component's data satisfies the underlying rules. More...
 
virtual int compare (const IODComponent &rhs) const
 Comparison operator for IOD Components. More...
 

Static Public Member Functions

static OFCondition create (const Float32 *dataValues, const unsigned long numValues, TrcMeasurement::Values *&values)
 Create TrcMeasurement::Values from minimal data. More...
 
static OFCondition createWithIndices (const Float32 *dataValues, const unsigned long numValues, const Uint32 *trackPointIndices, TrcMeasurement::Values *&values)
 Create TrcMeasurement::Values from minimal data by providing measurement values as well as indices of those points those measurement values apply to. More...
 
- Static Public Member Functions inherited from IODComponent
static OFCondition read (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that reads attributes from given item into destination item, as determined by the provided rules and component name. More...
 
static OFCondition write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
 Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. More...
 

Protected Member Functions

 Values ()
 Protected constructor, use create() method to create a new track set.
 

Friends

class DcmIODUtil
 

Additional Inherited Members

- Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItemm_Item
 Shared pointer to the data handled by this class. More...
 
OFshared_ptr< IODRulesm_Rules
 Rules describing the attributes governed by this class.
 
IODComponentm_Parent
 The parent component (may be NULL) of this class.
 

Detailed Description

Class that holds actual measurement values.

Member Function Documentation

◆ create()

static OFCondition TrcMeasurement::Values::create ( const Float32 *  dataValues,
const unsigned long  numValues,
TrcMeasurement::Values *&  values 
)
static

Create TrcMeasurement::Values from minimal data.

Parameters
dataValuesThe measurement values
numValuesThe number of measurement values. Must be equal to the numbers of data points in the related track.
valuesThe measurement values
Returns
EC_Normal if creating was successful, error otherwise

◆ createWithIndices()

static OFCondition TrcMeasurement::Values::createWithIndices ( const Float32 *  dataValues,
const unsigned long  numValues,
const Uint32 *  trackPointIndices,
TrcMeasurement::Values *&  values 
)
static

Create TrcMeasurement::Values from minimal data by providing measurement values as well as indices of those points those measurement values apply to.

Parameters
dataValuesThe measurement values
numValuesThe number of measurement values, must be equal or less to number of data points in the related track.
trackPointIndicesThe indices of the points the measurement values apply to
valuesThe measurement values
Returns
EC_Normal if creating was successful, error otherwise

◆ get()

virtual OFCondition TrcMeasurement::Values::get ( const Float32 *&  dataValues,
unsigned long &  numValues,
const Uint32 *&  trackPointIndices 
)
virtual

Get measurement values and the point indices (if applicable)

Parameters
dataValuesPointer to memory buffer with returned values
numValuesThe number of measurement values returned in dataValues
trackPointIndicesThe indices of the points the measurement values apply to. If there is a measurement value for each points in the track, NULL will be returned here.
Returns
EC_Normal if measurement values could be retrieved, error otherwise.

◆ getName()

virtual OFString TrcMeasurement::Values::getName ( ) const
virtual

Get name of component.

Returns
Name of the module ("MeasurementValuesSequenceItem")

Implements IODComponent.


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


Generated on Thu Nov 29 2018 for DCMTK Version 3.6.4 by Doxygen 1.8.14