Slicer  5.3
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
vtkMRMLStaticMeasurement Class Reference

Measurement class storing a constant measurement. More...

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

Inheritance diagram for vtkMRMLStaticMeasurement:
Inheritance graph
Collaboration diagram for vtkMRMLStaticMeasurement:
Collaboration graph

Public Types

typedef vtkMRMLMeasurement Superclass
- Public Types inherited from vtkMRMLMeasurement
enum  ComputationResult { NoChange =0, OK, InsufficientInput, InternalError }
enum  Events { InputDataModifiedEvent = vtkCommand::UserEvent + 555 }
typedef vtkObject Superclass

Public Member Functions

void Compute () override
 Do nothing to compute the measurement as it is static. More...
VTK_NEWINSTANCE vtkMRMLMeasurementCreateInstance () const override
 Create a new instance of this measurement type. More...
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) override
- Public Member Functions inherited from vtkMRMLMeasurement
virtual void Clear ()
 Reset state of object. Removes all content. More...
virtual void ClearValue (ComputationResult computationResult=NoChange)
virtual void Copy (vtkMRMLMeasurement *source)
 Copy one type into another (deep copy) More...
virtual void EnabledOff ()
virtual void EnabledOn ()
virtual vtkDoubleArray * GetControlPointValues ()
virtual vtkCodedEntryGetDerivationCode ()
virtual std::string GetDescription ()
 Informal description of the measurement. More...
virtual double GetDisplayCoefficient ()
double GetDisplayValue ()
virtual bool GetEnabled ()
 Enabled. More...
vtkMRMLNodeGetInputMRMLNode ()
 Get input MRML node used for calculating the measurement. More...
virtual int GetLastComputationResult ()
 Get last computation result. More...
const char * GetLastComputationResultAsPrintableString ()
 Get last computation result as human-readable string. More...
virtual vtkPolyData * GetMeshValue ()
virtual vtkCodedEntryGetMethodCode ()
virtual std::string GetName ()
 Measurement name. More...
virtual std::string GetPrintFormat ()
 Formatting string for displaying measurement value and units. More...
virtual vtkCodedEntryGetQuantityCode ()
virtual std::string GetUnits ()
 Measurement unit. More...
virtual vtkCodedEntryGetUnitsCode ()
virtual double GetValue ()
 Get quantity value. More...
virtual bool GetValueDefined ()
 Value defined flag (whether a computed value has been set or not) More...
std::string GetValueWithUnitsAsPrintableString ()
 Get measurement value and units as a single human-readable string. More...
void PrintSelf (ostream &os, vtkIndent indent) override
void SetControlPointValues (vtkDoubleArray *inputValues)
 Set the per-control point measurement values. More...
void SetDerivationCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
virtual void SetDescription (std::string)
virtual void SetDisplayCoefficient (double)
void SetDisplayValue (double value, const char *units=nullptr, double displayCoefficient=0.0)
virtual void SetEnabled (bool enabled)
void SetInputMRMLNode (vtkMRMLNode *node)
 Set input MRML node used for calculating the measurement. More...
void SetMeshValue (vtkPolyData *meshValue)
void SetMethodCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
virtual void SetName (std::string)
virtual void SetPrintFormat (std::string format)
void SetQuantityCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
virtual void SetUnits (std::string units)
void SetUnitsCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
void SetValue (double value, const char *quantityName=nullptr)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMRMLStaticMeasurementNew ()
static vtkMRMLStaticMeasurementSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLMeasurement
static int IsTypeOf (const char *type)
static vtkMRMLMeasurementSafeDownCast (vtkObject *o)

Protected Member Functions

void operator= (const vtkMRMLStaticMeasurement &)
 vtkMRMLStaticMeasurement ()
 vtkMRMLStaticMeasurement (const vtkMRMLStaticMeasurement &)
 ~vtkMRMLStaticMeasurement () override
- Protected Member Functions inherited from vtkMRMLMeasurement
vtkMRMLUnitNodeGetUnitNode (const char *quantityName)
 Helper function to get unit node from the scene based on quantity name. More...
void operator= (const vtkMRMLMeasurement &)
 vtkMRMLMeasurement ()
 vtkMRMLMeasurement (const vtkMRMLMeasurement &)
 ~vtkMRMLMeasurement () override

Additional Inherited Members

- Protected Attributes inherited from vtkMRMLMeasurement
vtkSmartPointer< vtkDoubleArray > ControlPointValues
 Per-control point measurements. More...
vtkSmartPointer< vtkCodedEntryDerivationCode
std::string Description
double DisplayCoefficient {1.0}
bool Enabled {true}
vtkWeakPointer< vtkMRMLNodeInputMRMLNode
 MRML node used to calculate the measurement. More...
ComputationResult LastComputationResult {InsufficientInput}
vtkSmartPointer< vtkPolyData > MeshValue
 Surface mesh for displaying computed value. More...
vtkSmartPointer< vtkCodedEntryMethodCode
std::string Name
std::string PrintFormat
vtkSmartPointer< vtkCodedEntryQuantityCode
std::string Units
vtkSmartPointer< vtkCodedEntryUnitsCode
double Value {0.0}
bool ValueDefined {false}

Detailed Description

Measurement class storing a constant measurement.

Typically all measurements calculate their own value from its input MRML node. This class is to be able to store constant measurements.

Definition at line 30 of file vtkMRMLStaticMeasurement.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkMRMLStaticMeasurement.h.

Constructor & Destructor Documentation

◆ vtkMRMLStaticMeasurement() [1/2]

vtkMRMLStaticMeasurement::vtkMRMLStaticMeasurement ( )

◆ ~vtkMRMLStaticMeasurement()

vtkMRMLStaticMeasurement::~vtkMRMLStaticMeasurement ( )

◆ vtkMRMLStaticMeasurement() [2/2]

vtkMRMLStaticMeasurement::vtkMRMLStaticMeasurement ( const vtkMRMLStaticMeasurement )

Member Function Documentation

◆ Compute()

void vtkMRMLStaticMeasurement::Compute ( )

Do nothing to compute the measurement as it is static.

Implements vtkMRMLMeasurement.

◆ CreateInstance()

VTK_NEWINSTANCE vtkMRMLMeasurement* vtkMRMLStaticMeasurement::CreateInstance ( ) const

Create a new instance of this measurement type.

Implements vtkMRMLMeasurement.

Definition at line 39 of file vtkMRMLStaticMeasurement.h.

◆ GetClassName()

virtual const char* vtkMRMLStaticMeasurement::GetClassName ( )

Reimplemented from vtkMRMLMeasurement.

◆ IsA()

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

Reimplemented from vtkMRMLMeasurement.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLStaticMeasurement* vtkMRMLStaticMeasurement::New ( )

◆ operator=()

void vtkMRMLStaticMeasurement::operator= ( const vtkMRMLStaticMeasurement )

◆ PrintSelf()

void vtkMRMLStaticMeasurement::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ SafeDownCast()

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

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