mars
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
mars::IMU Class Reference

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow. More...

#include <IMU.hpp>

Inheritance diagram for mars::IMU:

Public Member Functions

 IMU (std::string const &name="mars::IMU")
 
 IMU (std::string const &name, RTT::ExecutionEngine *engine)
 
 ~IMU ()
 
bool startHook ()
 The following lines are template definitions for the various state machine. More...
 
void updateHook ()
 
void stopHook ()
 

Protected Member Functions

virtual bool estimate_bias (boost::uint16_t duration)
 
void update (double time)
 

Protected Attributes

long node_id
 
base::samples::RigidBodyState rbs
 
base::samples::IMUSensors imusens
 
boost::mt19937 rnd_generator
 
boost::normal_distribution< double > translation_noise
 
boost::normal_distribution< double > rotation_noise
 
boost::normal_distribution< double > velocity_noise
 
boost::normal_distribution< double > angular_velocity_noise
 

Friends

class IMUBase
 

Detailed Description

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow.

The name of a TaskContext is primarily defined via:

deployment 'deployment_name'
    task('custom_task_name','mars::IMU')
end

It can be dynamically adapted when the deployment is called with a prefix argument.

Constructor & Destructor Documentation

◆ IMU() [1/2]

IMU::IMU ( std::string const &  name = "mars::IMU")

TaskContext constructor for IMU

Parameters
nameName of the task. This name needs to be unique to make it identifiable via nameservices.
initial_stateThe initial TaskState of the TaskContext. Default is Stopped state.

◆ IMU() [2/2]

IMU::IMU ( std::string const &  name,
RTT::ExecutionEngine *  engine 
)

TaskContext constructor for IMU

Parameters
nameName of the task. This name needs to be unique to make it identifiable for nameservices.
engineThe RTT Execution engine to be used for this task, which serialises the execution of all commands, programs, state machines and incoming events for a task.

◆ ~IMU()

IMU::~IMU ( )

Default deconstructor of IMU

Member Function Documentation

◆ estimate_bias()

virtual bool mars::IMU::estimate_bias ( boost::uint16_t  duration)
inlineprotectedvirtual

◆ startHook()

bool IMU::startHook ( )

The following lines are template definitions for the various state machine.

This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. If it returns false, then the component will stay in PreOperational. Otherwise, it goes into Stopped.

It is meaningful only if the #needs_configuration has been specified in the task context definition with (for example):

task_context "TaskName" do
  needs_configuration
  ...
end

This hook is called by Orocos when the state machine transitions from Stopped to Running. If it returns false, then the component will stay in Stopped. Otherwise, it goes into Running and updateHook() will be called.

◆ stopHook()

void IMU::stopHook ( )

This hook is called by Orocos when the component is in the RunTimeError state, at each activity step. See the discussion in updateHook() about triggering options.

Call recover() to go back in the Runtime state. This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

◆ update()

void IMU::update ( double  time)
protected

◆ updateHook()

void IMU::updateHook ( )

This hook is called by Orocos when the component is in the Running state, at each activity step. Here, the activity gives the "ticks" when the hook should be called.

The error(), exception() and fatal() calls, when called in this hook, allow to get into the associated RunTimeError, Exception and FatalError states.

In the first case, updateHook() is still called, and recover() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook(). In Exception, the component is stopped and recover() needs to be called before starting it again. Finally, FatalError cannot be recovered.

Friends And Related Function Documentation

◆ IMUBase

friend class IMUBase
friend

Member Data Documentation

◆ angular_velocity_noise

boost::normal_distribution<double> mars::IMU::angular_velocity_noise
protected

◆ imusens

base::samples::IMUSensors mars::IMU::imusens
protected

◆ node_id

long mars::IMU::node_id
protected

◆ rbs

base::samples::RigidBodyState mars::IMU::rbs
protected

◆ rnd_generator

boost::mt19937 mars::IMU::rnd_generator
protected

◆ rotation_noise

boost::normal_distribution<double> mars::IMU::rotation_noise
protected

◆ translation_noise

boost::normal_distribution<double> mars::IMU::translation_noise
protected

◆ velocity_noise

boost::normal_distribution<double> mars::IMU::velocity_noise
protected

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