vtkPlusParameters Class Reference

This class is used as the basis to store a configuration of generic parameters for any device. This class exists mainly for two reasons: Provide a standard interface for accessing parameters Enable standardized API for operating on parameters. More...

#include <src/PlusDataCollection/vtkPlusParameters.h>

Inheritance diagram for vtkPlusParameters:

Collaboration diagram for vtkPlusParameters:

Classes
class	ParameterInfo

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual PlusStatus	DeepCopy (const vtkPlusParameters &otherParameters)
virtual const char *	GetClassName ()
template<typename T >
PlusStatus	GetValue (const std::string &paramName, T &outputValue) const
virtual int	IsA (const char *type)
bool	IsPending (const std::string &paramName) const
bool	IsSet (const std::string &paramName) const
virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *deviceConfig)
PlusStatus	SetPending (const std::string &paramName, bool pending)
template<typename T >
PlusStatus	SetValue (const std::string &paramName, T aValue)
virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *deviceConfig)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlusParameters *	New ()
static vtkPlusParameters *	SafeDownCast (vtkObject *o)

Static Public Attributes
static const char *	NAME_TAG = "Name"
static const char *	PARAMETER_TAG = "Parameter"
static const char *	VALUE_TAG = "Value"
static const char *	XML_ELEMENT_TAG = "Parameters"

Protected Types
typedef std::map< std::string, ParameterInfo >	ParameterMap
typedef ParameterMap::const_iterator	ParameterMapConstIterator
typedef ParameterMap::iterator	ParameterMapIterator

Protected Member Functions
ParameterMapConstIterator	begin () const
ParameterMapConstIterator	end () const
virtual const char *	GetXMLElementName ()
	vtkPlusParameters ()
virtual	~vtkPlusParameters ()

Protected Attributes
ParameterMap	Parameters

Detailed Description

This class is used as the basis to store a configuration of generic parameters for any device. This class exists mainly for two reasons: Provide a standard interface for accessing parameters Enable standardized API for operating on parameters.

Definition at line 24 of file vtkPlusParameters.h.

Member Typedef Documentation

ParameterMap

typedef std::map<std::string, ParameterInfo> vtkPlusParameters::ParameterMap

protected

Definition at line 41 of file vtkPlusParameters.h.

ParameterMapConstIterator

typedef ParameterMap::const_iterator vtkPlusParameters::ParameterMapConstIterator

protected

Definition at line 43 of file vtkPlusParameters.h.

ParameterMapIterator

typedef ParameterMap::iterator vtkPlusParameters::ParameterMapIterator

protected

Definition at line 42 of file vtkPlusParameters.h.

Superclass

typedef vtkObject vtkPlusParameters::Superclass

Definition at line 58 of file vtkPlusParameters.h.

Constructor & Destructor Documentation

vtkPlusParameters()

vtkPlusParameters::vtkPlusParameters ( )

protected

Definition at line 23 of file vtkPlusParameters.cxx.

~vtkPlusParameters()

vtkPlusParameters::~vtkPlusParameters ( )

protectedvirtual

Definition at line 29 of file vtkPlusParameters.cxx.

Member Function Documentation

begin()

vtkPlusParameters::ParameterMapConstIterator vtkPlusParameters::begin ( ) const

protected

Return an iterator to the beginning of the parameter space

Definition at line 36 of file vtkPlusParameters.cxx.

DeepCopy()

PlusStatus vtkPlusParameters::DeepCopy ( const vtkPlusParameters &  otherParameters )

virtual

Copy the values from another imaging parameters

Definition at line 190 of file vtkPlusParameters.cxx.

end()

vtkPlusParameters::ParameterMapConstIterator vtkPlusParameters::end ( ) const

protected

Return an iterator to the end of the parameter space

Definition at line 42 of file vtkPlusParameters.cxx.

GetClassName()

virtual const char* vtkPlusParameters::GetClassName ( )

virtual

Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.

GetValue()

template<typename T >

PlusStatus vtkPlusParameters::GetValue ( const std::string &  paramName, T &  outputValue  ) const

inline

Request a stored value by key name

Parameters

paramName	the key value to retrieve
outputValue	the output variable to write to

Definition at line 84 of file vtkPlusParameters.h.

GetXMLElementName()

virtual const char* vtkPlusParameters::GetXMLElementName ( )

inlineprotectedvirtual

Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.

Definition at line 143 of file vtkPlusParameters.h.

IsA()

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

virtual

Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.

IsPending()

bool vtkPlusParameters::IsPending

(

const std::string &

paramName

)

const

Request the pending status of a parameter

Parameters

paramName

the key value to retrieve

Definition at line 155 of file vtkPlusParameters.cxx.

IsSet()

bool vtkPlusParameters::IsSet

(

const std::string &

paramName

)

const

Request the set status of a parameter (whether it is not the default value)

Parameters

paramName

the key value to retrieve

Definition at line 142 of file vtkPlusParameters.cxx.

IsTypeOf()

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

static

New()

static vtkPlusParameters* vtkPlusParameters::New ( )

static

PrintSelf()

void vtkPlusParameters::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Print the list of supported parameters. For diagnostic purposes only.

Definition at line 48 of file vtkPlusParameters.cxx.

ReadConfiguration()

PlusStatus vtkPlusParameters::ReadConfiguration ( vtkXMLDataElement *  deviceConfig )

virtual

Read main configuration from/to XML data Assumes that the data element passed is the device element, not the root!

Parameters

deviceConfig

the XML element of the device

Definition at line 63 of file vtkPlusParameters.cxx.

SafeDownCast()

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

static

SetPending()

PlusStatus vtkPlusParameters::SetPending	(	const std::string &	paramName,
		bool	pending
	)

Set the pending status of a parameter

Definition at line 168 of file vtkPlusParameters.cxx.

SetValue()

template<typename T >

PlusStatus vtkPlusParameters::SetValue ( const std::string &  paramName, T  aValue  )

inline

Set a stored value by key name Defined in the header to make it available externally

Parameters

paramName	the key value to retrieve
aValue	the value to write

Definition at line 109 of file vtkPlusParameters.h.

WriteConfiguration()

PlusStatus vtkPlusParameters::WriteConfiguration ( vtkXMLDataElement *  deviceConfig )

virtual

Write main configuration from/to XML data Assumes that the data element passed is the device element, not the root!

Parameters

deviceConfig

the XML element of the device

Definition at line 105 of file vtkPlusParameters.cxx.

Member Data Documentation

NAME_TAG

const char * vtkPlusParameters::NAME_TAG = "Name"

static

Definition at line 53 of file vtkPlusParameters.h.

PARAMETER_TAG

const char * vtkPlusParameters::PARAMETER_TAG = "Parameter"

static

Definition at line 52 of file vtkPlusParameters.h.

Parameters

ParameterMap vtkPlusParameters::Parameters

protected

Definition at line 143 of file vtkPlusParameters.h.

VALUE_TAG

const char * vtkPlusParameters::VALUE_TAG = "Value"

static

Definition at line 54 of file vtkPlusParameters.h.

XML_ELEMENT_TAG

const char * vtkPlusParameters::XML_ELEMENT_TAG = "Parameters"

static

Definition at line 51 of file vtkPlusParameters.h.

---

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

• src/PlusDataCollection/vtkPlusParameters.h
• src/PlusDataCollection/vtkPlusParameters.cxx