LabJackToPoseFilter Class Reference
Inheritance diagram for LabJackToPoseFilter:

## Public Member Functions

| LabJackToPoseFilter (const std::string &name, int firstTimerForQuadrature, int resetQuadrature, int plusX, int minusX, double translationPerUpdate, int positiveAnalogDifferential, int analogSingleEnded, int xOut, int loopbackOut)
void | initializeInput (const std::string &device, const DataGroup &inputData) override
| Set the initial input data group. More...
void | filterInput (const std::string &device, const DataGroup &dataToFilter, DataGroup *result) override
| Filter the input data. More...
void | filterOutput (const std::string &device, const DataGroup &dataToFilter, DataGroup *result) override
| Filter the output data. More...
Public Member Functions inherited from SurgSim::Devices::DeviceFilter
| DeviceFilter (const std::string &name)
| Constructor. More...
| SURGSIM_CLASSNAME (SurgSim::Devices::DeviceFilter)
bool | initialize () override
| Fully initialize the device. More...
bool | isInitialized () const override
void | handleInput (const std::string &device, const DataStructures::DataGroup &inputData) override
| Notifies the consumer that the application input coming from the device has been updated. More...
bool | requestOutput (const std::string &device, DataStructures::DataGroup *outputData) override
| Asks the producer to provide output state to the device. More...
Public Member Functions inherited from SurgSim::Input::CommonDevice
| CommonDevice (const std::string &name)
| Constructor. More...
| CommonDevice (const std::string &name, const DataStructures::DataGroup &inputData)
| Constructor. More...
| CommonDevice (const std::string &name, DataStructures::DataGroup &&inputData)
| Constructor. More...
virtual | ~CommonDevice ()
| Destructor. More...
std::string | getName () const override
| Return a (hopefully unique) device name. More...
std::string | getClassName () const override
| The class name for this class. More...
void | setNameForCallback (const std::string &name)
| Set the name used for calling the input consumers and output producer. More...
std::string | getNameForCallback () const
| Get the name used for calling the input consumers and output producer. More...
bool | addInputConsumer (std::shared_ptr< InputConsumerInterface > inputConsumer) override
| Adds an input consumer that will be notified when the application input state is updated. More...
bool | removeInputConsumer (std::shared_ptr< InputConsumerInterface > inputConsumer) override
| Removes an input consumer previously added via addInputConsumer. More...
void | clearInputConsumers () override
| Removes all InputConsumers. More...
bool | setOutputProducer (std::shared_ptr< OutputProducerInterface > outputProducer) override
| Sets an output producer that will be asked for application output state when the device needs it. More...
bool | removeOutputProducer (std::shared_ptr< OutputProducerInterface > outputProducer) override
| Removes an output producer previously added via setOutputProducer. More...
bool | hasOutputProducer () override
| Query if this object has output producer. More...
void | clearOutputProducer () override
| Removes any OutputProducer. More...
Public Member Functions inherited from SurgSim::Input::DeviceInterface
virtual | ~DeviceInterface ()
| Virtual destructor (empty). More...
Public Member Functions inherited from SurgSim::Framework::Accessible
| Accessible ()
| Default Constructor. More...
| ~Accessible ()
| Destructor. More...
template<class T >
T | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
boost::any | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found. More...
template<class T >
bool | getValue (const std::string &name, T *value) const
| Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
void | setValue (const std::string &name, const boost::any &value)
| Sets a value of a property that has setter. More...
bool | isReadable (const std::string &name) const
| Check whether a property is readable. More...
bool | isWriteable (const std::string &name) const
| Check whether a property is writable. More...
void | setGetter (const std::string &name, GetterType func)
| Sets a getter for a given property. More...
void | setSetter (const std::string &name, SetterType func)
| Sets a setter for a given property. More...
void | setAccessors (const std::string &name, GetterType getter, SetterType setter)
| Sets the accessors getter and setter in one function. More...
void | removeAccessors (const std::string &name)
| Removes all the accessors (getter and setter) for a given property. More...
void | forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
| Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
void | setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
| Sets the functions used to convert data from and to a YAML::Node. More...
void | setDecoder (const std::string &name, DecoderType decoder)
| Sets the functions used to convert data from a YAML::Node. More...
YAML::Node | encode () const
| Encode this Accessible to a YAML::Node. More...
void | decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
| Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
template<>
boost::any | getValue (const std::string &name) const
Public Member Functions inherited from SurgSim::Input::InputConsumerInterface
virtual | ~InputConsumerInterface ()
| Virtual destructor (empty). More...
Public Member Functions inherited from SurgSim::Input::OutputProducerInterface
virtual | ~OutputProducerInterface ()
| Virtual destructor (empty). More...

## Private Attributes

DataGroup | m_outputData
DataGroup | m_lastInputData
RigidTransform3d | m_pose
double | m_translationPerUpdate
int | m_lineForPlusX
int | m_lineForMinusX
int | m_firstTimerForQuadrature
int | m_lineForResetQuadrature
int | m_analogInputDifferentialPositive
int | m_analogInputDifferentialNegative
int | m_analogInputSingleEnded
bool | m_cachedOutputIndices
int | m_poseIndex
int | m_digitalInputPlusXIndex
int | m_digitalInputMinusXIndex
int | m_timerInputIndex
int | m_analogInputDifferentialIndex
int | m_analogInputSingleEndedIndex
int | m_analogOutputIndex
int | m_digitalOutputIndex

## Additional Inherited Members

Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)> | GetterType
typedef std::function< void(boost::any)> | SetterType
typedef std::function< YAML::Node(void)> | EncoderType
typedef std::function< void(const YAML::Node *)> | DecoderType
Public Types inherited from SurgSim::Framework::FactoryBase1< DeviceInterface, std::string >
typedef ObjectFactory1< DeviceInterface, std::string > | FactoryType
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< DeviceInterface, std::string >
static FactoryType & | getFactory ()
Protected Member Functions inherited from SurgSim::Devices::DeviceFilter
bool | finalize () override
| Finalize (de-initialize) the device. More...
Protected Member Functions inherited from SurgSim::Input::CommonDevice
virtual void | pushInput ()
| Push application input to consumers. More...
virtual bool | pullOutput ()
| Pull application output from a producer. More...
DataStructures::DataGroup & | getInputData ()
| Getter for the input data DataGroup. More...
const DataStructures::DataGroup & | getOutputData () const
| Getter for the output data DataGroup. More...
Protected Attributes inherited from SurgSim::Devices::DeviceFilter
bool | m_initialized
| true if initialized and not finalized. More...

## Constructor & Destructor Documentation

## LabJackToPoseFilter()

LabJackToPoseFilter::LabJackToPoseFilter | ( | const std::string & | name,
|  | int | firstTimerForQuadrature,
|  | int | resetQuadrature,
|  | int | plusX,
|  | int | minusX,
|  | double | translationPerUpdate,
|  | int | positiveAnalogDifferential,
|  | int | analogSingleEnded,
|  | int | xOut,
|  | int | loopbackOut
| ) |  |

inline

## Member Function Documentation

## filterInput()

void LabJackToPoseFilter::filterInput | ( | const std::string & | device,
|  | const DataGroup & | dataToFilter,
|  | DataGroup * | result
| ) |  |

inline override virtual

Filter the input data.

Parameters

  | device | The name of the device pushing the input data.
  | dataToFilter | The data that will be filtered.
  [in,out] | result | A pointer to a DataGroup object that must be assignable to by the dataToFilter object. Will contain the filtered data.

Reimplemented from SurgSim::Devices::DeviceFilter.

## filterOutput()

void LabJackToPoseFilter::filterOutput | ( | const std::string & | device,
|  | const DataGroup & | dataToFilter,
|  | DataGroup * | result
| ) |  |

inline override virtual

Filter the output data.

Parameters

  | device | The name of the device pulling the output data.
  | dataToFilter | The data that will be filtered.
  [in,out] | result | A pointer to a DataGroup object that must be assignable to by the dataToFilter object. Will contain the filtered data.

Reimplemented from SurgSim::Devices::DeviceFilter.

## initializeInput()

void LabJackToPoseFilter::initializeInput | ( | const std::string & | device,
|  | const DataGroup & | inputData
| ) |  |

inline override virtual

Set the initial input data group.

Parameters

  device | The name of the device that is producing the input. This should only be used to identify the device (e.g. if the consumer is listening to several devices at once).
  inputData | The application input state coming from the device.

Reimplemented from SurgSim::Devices::DeviceFilter.

## Member Data Documentation

## m_analogInputDifferentialIndex

int LabJackToPoseFilter::m_analogInputDifferentialIndex

private

## m_analogInputDifferentialNegative

int LabJackToPoseFilter::m_analogInputDifferentialNegative

private

## m_analogInputDifferentialPositive

int LabJackToPoseFilter::m_analogInputDifferentialPositive

private

## m_analogInputSingleEnded

int LabJackToPoseFilter::m_analogInputSingleEnded

private

## m_analogInputSingleEndedIndex

int LabJackToPoseFilter::m_analogInputSingleEndedIndex

private

## m_analogOutputIndex

int LabJackToPoseFilter::m_analogOutputIndex

private

## m_cachedOutputIndices

bool LabJackToPoseFilter::m_cachedOutputIndices

private

## m_digitalInputMinusXIndex

int LabJackToPoseFilter::m_digitalInputMinusXIndex

private

## m_digitalInputPlusXIndex

int LabJackToPoseFilter::m_digitalInputPlusXIndex

private

## m_digitalOutputIndex

int LabJackToPoseFilter::m_digitalOutputIndex

private

## m_firstTimerForQuadrature

int LabJackToPoseFilter::m_firstTimerForQuadrature

private

## m_lastInputData

DataGroup LabJackToPoseFilter::m_lastInputData

private

## m_lineForMinusX

int LabJackToPoseFilter::m_lineForMinusX

private

## m_lineForPlusX

int LabJackToPoseFilter::m_lineForPlusX

private

## m_lineForResetQuadrature

int LabJackToPoseFilter::m_lineForResetQuadrature

private

## m_outputData

DataGroup LabJackToPoseFilter::m_outputData

private

## m_pose

RigidTransform3d LabJackToPoseFilter::m_pose

private

## m_poseIndex

int LabJackToPoseFilter::m_poseIndex

private

## m_timerInputIndex

int LabJackToPoseFilter::m_timerInputIndex

private

## m_translationPerUpdate

double LabJackToPoseFilter::m_translationPerUpdate

private

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

- SurgSim/Devices/LabJack/VisualTest/main.cpp