ImFusion SDK 4.3
ProbeTrackerPair Class Reference

#include <ImFusion/US/SweepCalibrationData.h>

Class uniquely identifying a probe-tracker pair via probe-name and tracker-ID. More...

+ Inheritance diagram for ProbeTrackerPair:

Detailed Description

Class uniquely identifying a probe-tracker pair via probe-name and tracker-ID.

Public Member Functions

 ProbeTrackerPair (std::string probeName, std::string trackerName)
 Constructor via probe-name and tracker-name. For backward compatibility only, as the name of the tracker is not unique.
 
 ProbeTrackerPair (std::string probeName, const TrackerID &trackerID)
 Constructor via probe-name and TrackerID.
 
bool operator< (const ProbeTrackerPair &other) const
 Less-than operator for usage in e.g. a map.
 
bool operator== (const ProbeTrackerPair &other) const
 
std::string string () const
 
void configure (const Properties *p) override
 Configures the pair, expects "probe" and "trackerID".
 
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
 
- Public Member Functions inherited from Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
 
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
 
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 
 Configurable (const Configurable &rhs)
 
 Configurable (Configurable &&rhs) noexcept
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Static Public Member Functions

static ProbeTrackerPair fromString (std::string probetracker)
 Legacy conversion of "Probe-Tracker" string to ProbeTrackerPair, only meant for backward compatibility.
 

Additional Inherited Members

- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Constructor & Destructor Documentation

◆ ProbeTrackerPair()

ProbeTrackerPair ( std::string probeName,
std::string trackerName )

Constructor via probe-name and tracker-name. For backward compatibility only, as the name of the tracker is not unique.

Deprecated
"Use ProbeTrackerPair(std::string, const TrackerID&) instead"

Member Function Documentation

◆ configure()

void configure ( const Properties * p)
overridevirtual

Configures the pair, expects "probe" and "trackerID".

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configure() for the inverse functionality

Reimplemented from Configurable.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close