camera_firewire
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
camera_firewire::CameraTask Class Reference

#include <CameraTask.hpp>

Inheritance diagram for camera_firewire::CameraTask:

Public Member Functions

 CameraTask (std::string const &name="camera_firewire::CameraTask")
 
 ~CameraTask ()
 
bool configureHook ()
 The following lines are template definitions for the various state machine. More...
 
void cleanupHook ()
 

Public Attributes

aggregator::TimestampEstimator * timestampEstimator
 

Protected Member Functions

virtual bool setHDRValues (int hdr_voltage_1, int hdr_voltage_2, int hdr_voltage_3, int hdr_voltage_4)
 
virtual void onRetrieveNewFrame (base::samples::frame::Frame &frame)
 

Protected Attributes

camera::CamFireWire * camera
 

Friends

class CameraTaskBase
 

Constructor & Destructor Documentation

◆ CameraTask()

CameraTask::CameraTask ( std::string const &  name = "camera_firewire::CameraTask")

◆ ~CameraTask()

CameraTask::~CameraTask ( )

Member Function Documentation

◆ cleanupHook()

void CameraTask::cleanupHook ( )

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. 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. See README.txt for different triggering options.

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

In the first case, updateHook() is still called, and recovered() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook() and in the third case the component is stopped and resetError() needs to be called before starting it again. 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 recovered() 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. This hook is called by Orocos when the state machine transitions from Stopped to PreOperational, requiring the call to configureHook() before calling start() again.

◆ configureHook()

bool CameraTask::configureHook ( )

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

◆ onRetrieveNewFrame()

void CameraTask::onRetrieveNewFrame ( base::samples::frame::Frame &  frame)
protectedvirtual

Callback function, will triggered if a new frame was retrieved.

Parameters
framethe new frame

◆ setHDRValues()

bool CameraTask::setHDRValues ( int  hdr_voltage_1,
int  hdr_voltage_2,
int  hdr_voltage_3,
int  hdr_voltage_4 
)
protectedvirtual

Friends And Related Function Documentation

◆ CameraTaskBase

friend class CameraTaskBase
friend

Member Data Documentation

◆ camera

camera::CamFireWire* camera_firewire::CameraTask::camera
protected

◆ timestampEstimator

aggregator::TimestampEstimator* camera_firewire::CameraTask::timestampEstimator

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