SF2 C++ FRC Class Library
Sensor Fusion Framework (SF2) for FRC
Public Member Functions | Static Public Member Functions | List of all members
SensorDataSourceInfo Class Reference

Public Member Functions

 SensorDataSourceInfo (string name, IQuantity &value, vector< IUnit * > &units)
 
 SensorDataSourceInfo (string name, IQuantity &value, IUnit &units)
 
string getName ()
 Returns the name of this sensor data. More...
 
IQuantitygetQuantity ()
 Returns the class object corresponding to the sensor quantity data type. More...
 
const vector< IUnit * > & getQuantityUnits ()
 Returns an array of IUnit objects describing the units of the sensor quantity data type. More...
 

Static Public Member Functions

static void getQuantityArray (vector< SensorDataSourceInfo * > &data_source, vector< IQuantity * > &quantity_list)
 

Member Function Documentation

string SensorDataSourceInfo::getName ( )
inline

Returns the name of this sensor data.

This name must be unique among all SensorDataInfos produced by any sensor.

IQuantity& SensorDataSourceInfo::getQuantity ( )
inline

Returns the class object corresponding to the sensor quantity data type.

Returns
const vector<IUnit *>& SensorDataSourceInfo::getQuantityUnits ( )
inline

Returns an array of IUnit objects describing the units of the sensor quantity data type.

If a complex quantity data type (which implements the IQuantityContainer interface, multiple IUnit objects may be returned. The count and order of the IUnit corresponds to the IQuantity objects contained within the quantity data type.

Returns

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