Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMRMLMeasurement Class Reference

Class for storing well-defined measurement results, using coded entries. More...

#include <Libs/MRML/Core/vtkMRMLMeasurement.h>

Inheritance diagram for vtkMRMLMeasurement:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLMeasurement:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual void Copy (vtkMRMLMeasurement *aEntry)
 Copy one type into another (deep copy) More...
 
std::string GetAsString ()
 
Get content of the object as a single machine-readable string. More...
 
virtual const char * GetClassName ()
 
virtual vtkCodedEntryGetDerivationCode ()
 
virtual char * GetDescription ()
 Informal description of the measurement. More...
 
virtual vtkCodedEntryGetMethodCode ()
 
virtual char * GetName ()
 Measurement name. More...
 
virtual char * GetPrintFormat ()
 Formatting string for displaying measurement value and units. More...
 
virtual vtkCodedEntryGetQuantityCode ()
 
virtual char * GetUnits ()
 Measurement unit. More...
 
virtual vtkCodedEntryGetUnitsCode ()
 
virtual double GetValue ()
 Measured quantity value. More...
 
std::string GetValueWithUnitsAsPrintableString ()
 
Get measurement value and units as a single human-readable string. More...
 
virtual void Initialize ()
 Reset state of object. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetDerivationCode (vtkCodedEntry *entry)
 
virtual void SetDescription (const char *)
 
bool SetFromString (const std::string &content)
 
void SetMethodCode (vtkCodedEntry *entry)
 
virtual void SetName (const char *)
 
virtual void SetPrintFormat (const char *)
 
void SetQuantityCode (vtkCodedEntry *entry)
 
virtual void SetUnits (const char *)
 
void SetUnitsCode (vtkCodedEntry *entry)
 
virtual void SetValue (double)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLMeasurementNew ()
 
static vtkMRMLMeasurementSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLMeasurement &)
 
 vtkMRMLMeasurement ()
 
 vtkMRMLMeasurement (const vtkMRMLMeasurement &)
 
 ~vtkMRMLMeasurement () override
 

Protected Attributes

vtkCodedEntryDerivationCode
 
char * Description
 
vtkCodedEntryMethodCode
 
char * Name
 
char * PrintFormat
 
vtkCodedEntryQuantityCode
 
char * Units
 
vtkCodedEntryUnitsCode
 
double Value
 

Detailed Description

Class for storing well-defined measurement results, using coded entries.

This stores all important information about a measurement using standard coded entries. Measurement method, derivation, quantity value, units, etc, can be specified. This is a commonly used concept in DICOM structured reports.

See also
vtkCodedEntry

Definition at line 29 of file vtkMRMLMeasurement.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkMRMLMeasurement::Superclass

Definition at line 34 of file vtkMRMLMeasurement.h.

Constructor & Destructor Documentation

◆ vtkMRMLMeasurement() [1/2]

vtkMRMLMeasurement::vtkMRMLMeasurement ( )
protected

◆ ~vtkMRMLMeasurement()

vtkMRMLMeasurement::~vtkMRMLMeasurement ( )
overrideprotected

◆ vtkMRMLMeasurement() [2/2]

vtkMRMLMeasurement::vtkMRMLMeasurement ( const vtkMRMLMeasurement )
protected

Member Function Documentation

◆ Copy()

virtual void vtkMRMLMeasurement::Copy ( vtkMRMLMeasurement aEntry)
virtual

Copy one type into another (deep copy)

◆ GetAsString()

std::string vtkMRMLMeasurement::GetAsString ( )


Get content of the object as a single machine-readable string.

◆ GetClassName()

virtual const char* vtkMRMLMeasurement::GetClassName ( )
virtual

◆ GetDerivationCode()

virtual vtkCodedEntry* vtkMRMLMeasurement::GetDerivationCode ( )
virtual

◆ GetDescription()

virtual char* vtkMRMLMeasurement::GetDescription ( )
virtual

Informal description of the measurement.

◆ GetMethodCode()

virtual vtkCodedEntry* vtkMRMLMeasurement::GetMethodCode ( )
virtual

◆ GetName()

virtual char* vtkMRMLMeasurement::GetName ( )
virtual

Measurement name.

◆ GetPrintFormat()

virtual char* vtkMRMLMeasurement::GetPrintFormat ( )
virtual

Formatting string for displaying measurement value and units.

◆ GetQuantityCode()

virtual vtkCodedEntry* vtkMRMLMeasurement::GetQuantityCode ( )
virtual

◆ GetUnits()

virtual char* vtkMRMLMeasurement::GetUnits ( )
virtual

Measurement unit.

◆ GetUnitsCode()

virtual vtkCodedEntry* vtkMRMLMeasurement::GetUnitsCode ( )
virtual

◆ GetValue()

virtual double vtkMRMLMeasurement::GetValue ( )
virtual

Measured quantity value.

◆ GetValueWithUnitsAsPrintableString()

std::string vtkMRMLMeasurement::GetValueWithUnitsAsPrintableString ( )


Get measurement value and units as a single human-readable string.

◆ Initialize()

virtual void vtkMRMLMeasurement::Initialize ( )
virtual

Reset state of object.

◆ IsA()

virtual int vtkMRMLMeasurement::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkMRMLMeasurement::IsTypeOf ( const char *  type)
static

◆ New()

static vtkMRMLMeasurement* vtkMRMLMeasurement::New ( )
static

◆ operator=()

void vtkMRMLMeasurement::operator= ( const vtkMRMLMeasurement )
protected

◆ PrintSelf()

void vtkMRMLMeasurement::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

static vtkMRMLMeasurement* vtkMRMLMeasurement::SafeDownCast ( vtkObject *  o)
static

◆ SetDerivationCode()

void vtkMRMLMeasurement::SetDerivationCode ( vtkCodedEntry entry)

◆ SetDescription()

virtual void vtkMRMLMeasurement::SetDescription ( const char *  )
virtual

◆ SetFromString()

bool vtkMRMLMeasurement::SetFromString ( const std::string &  content)

Set content of the object from a single machine-readable string.

Returns
true on success

◆ SetMethodCode()

void vtkMRMLMeasurement::SetMethodCode ( vtkCodedEntry entry)

◆ SetName()

virtual void vtkMRMLMeasurement::SetName ( const char *  )
virtual

◆ SetPrintFormat()

virtual void vtkMRMLMeasurement::SetPrintFormat ( const char *  )
virtual

◆ SetQuantityCode()

void vtkMRMLMeasurement::SetQuantityCode ( vtkCodedEntry entry)

◆ SetUnits()

virtual void vtkMRMLMeasurement::SetUnits ( const char *  )
virtual

◆ SetUnitsCode()

void vtkMRMLMeasurement::SetUnitsCode ( vtkCodedEntry entry)

◆ SetValue()

virtual void vtkMRMLMeasurement::SetValue ( double  )
virtual

Member Data Documentation

◆ DerivationCode

vtkCodedEntry* vtkMRMLMeasurement::DerivationCode
protected

Definition at line 105 of file vtkMRMLMeasurement.h.

◆ Description

char* vtkMRMLMeasurement::Description
protected

Definition at line 102 of file vtkMRMLMeasurement.h.

◆ MethodCode

vtkCodedEntry* vtkMRMLMeasurement::MethodCode
protected

Definition at line 107 of file vtkMRMLMeasurement.h.

◆ Name

char* vtkMRMLMeasurement::Name
protected

Definition at line 99 of file vtkMRMLMeasurement.h.

◆ PrintFormat

char* vtkMRMLMeasurement::PrintFormat
protected

Definition at line 103 of file vtkMRMLMeasurement.h.

◆ QuantityCode

vtkCodedEntry* vtkMRMLMeasurement::QuantityCode
protected

Definition at line 104 of file vtkMRMLMeasurement.h.

◆ Units

char* vtkMRMLMeasurement::Units
protected

Definition at line 101 of file vtkMRMLMeasurement.h.

◆ UnitsCode

vtkCodedEntry* vtkMRMLMeasurement::UnitsCode
protected

Definition at line 106 of file vtkMRMLMeasurement.h.

◆ Value

double vtkMRMLMeasurement::Value
protected

Definition at line 100 of file vtkMRMLMeasurement.h.


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