PlusLib
2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
|
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>
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 ¶mName, T &outputValue) const |
virtual int | IsA (const char *type) |
bool | IsPending (const std::string ¶mName) const |
bool | IsSet (const std::string ¶mName) const |
virtual void | PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE |
virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *deviceConfig) |
PlusStatus | SetPending (const std::string ¶mName, bool pending) |
template<typename T > | |
PlusStatus | SetValue (const std::string ¶mName, 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 |
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.
|
protected |
Definition at line 41 of file vtkPlusParameters.h.
|
protected |
Definition at line 43 of file vtkPlusParameters.h.
|
protected |
Definition at line 42 of file vtkPlusParameters.h.
typedef vtkObject vtkPlusParameters::Superclass |
Definition at line 58 of file vtkPlusParameters.h.
|
protected |
Definition at line 23 of file vtkPlusParameters.cxx.
|
protectedvirtual |
Definition at line 29 of file vtkPlusParameters.cxx.
|
protected |
Return an iterator to the beginning of the parameter space
Definition at line 36 of file vtkPlusParameters.cxx.
|
virtual |
Copy the values from another imaging parameters
Definition at line 190 of file vtkPlusParameters.cxx.
|
protected |
Return an iterator to the end of the parameter space
Definition at line 42 of file vtkPlusParameters.cxx.
|
virtual |
Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.
|
inline |
Request a stored value by key name
paramName | the key value to retrieve |
outputValue | the output variable to write to |
Definition at line 84 of file vtkPlusParameters.h.
|
inlineprotectedvirtual |
Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.
Definition at line 143 of file vtkPlusParameters.h.
|
virtual |
Reimplemented in vtkPlusUsImagingParameters, and vtkPlusCameraControlParameters.
bool vtkPlusParameters::IsPending | ( | const std::string & | paramName | ) | const |
Request the pending status of a parameter
paramName | the key value to retrieve |
Definition at line 155 of file vtkPlusParameters.cxx.
bool vtkPlusParameters::IsSet | ( | const std::string & | paramName | ) | const |
Request the set status of a parameter (whether it is not the default value)
paramName | the key value to retrieve |
Definition at line 142 of file vtkPlusParameters.cxx.
|
static |
|
static |
|
virtual |
Print the list of supported parameters. For diagnostic purposes only.
Definition at line 48 of file vtkPlusParameters.cxx.
|
virtual |
Read main configuration from/to XML data Assumes that the data element passed is the device element, not the root!
deviceConfig | the XML element of the device |
Definition at line 63 of file vtkPlusParameters.cxx.
|
static |
PlusStatus vtkPlusParameters::SetPending | ( | const std::string & | paramName, |
bool | pending | ||
) |
Set the pending status of a parameter
Definition at line 168 of file vtkPlusParameters.cxx.
|
inline |
Set a stored value by key name Defined in the header to make it available externally
paramName | the key value to retrieve |
aValue | the value to write |
Definition at line 109 of file vtkPlusParameters.h.
|
virtual |
Write main configuration from/to XML data Assumes that the data element passed is the device element, not the root!
deviceConfig | the XML element of the device |
Definition at line 105 of file vtkPlusParameters.cxx.
|
static |
Definition at line 53 of file vtkPlusParameters.h.
|
static |
Definition at line 52 of file vtkPlusParameters.h.
|
protected |
Definition at line 143 of file vtkPlusParameters.h.
|
static |
Definition at line 54 of file vtkPlusParameters.h.
|
static |
Definition at line 51 of file vtkPlusParameters.h.