projection
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
projection::VirtualView 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 <VirtualView.hpp>

Inheritance diagram for projection::VirtualView:

Public Member Functions

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

Protected Member Functions

void checkComplete ()
 
void addCam (const base::Affine3d &cam2body, const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &frame, int id)
 
virtual void cam1TransformerCallback (const base::Time &ts, const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &cam1_sample)
 
virtual void cam2TransformerCallback (const base::Time &ts, const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &cam2_sample)
 
virtual void cam3TransformerCallback (const base::Time &ts, const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &cam3_sample)
 
virtual void cam4TransformerCallback (const base::Time &ts, const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &cam4_sample)
 

Protected Attributes

projection::Homography hom
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > viewFrame
 
base::samples::frame::Frame tmpFrame
 
frame_helper::FrameHelper frameHelper
 
std::set< int > addedCams
 
base::Time last_sample_ts
 

Friends

class VirtualViewBase
 

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','projection::VirtualView')
end

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

Constructor & Destructor Documentation

◆ VirtualView() [1/2]

VirtualView::VirtualView ( std::string const &  name = "projection::VirtualView")

TaskContext constructor for VirtualView

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.

◆ VirtualView() [2/2]

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

TaskContext constructor for VirtualView

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.

◆ ~VirtualView()

VirtualView::~VirtualView ( )

Default deconstructor of VirtualView

Member Function Documentation

◆ addCam()

void VirtualView::addCam ( const base::Affine3d &  cam2body,
const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &  frame,
int  id 
)
protected

◆ cam1TransformerCallback()

void VirtualView::cam1TransformerCallback ( const base::Time &  ts,
const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &  cam1_sample 
)
protectedvirtual

◆ cam2TransformerCallback()

void VirtualView::cam2TransformerCallback ( const base::Time &  ts,
const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &  cam2_sample 
)
protectedvirtual

◆ cam3TransformerCallback()

void VirtualView::cam3TransformerCallback ( const base::Time &  ts,
const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &  cam3_sample 
)
protectedvirtual

◆ cam4TransformerCallback()

void VirtualView::cam4TransformerCallback ( const base::Time &  ts,
const ::RTT::extras::ReadOnlyPointer< ::base::samples::frame::Frame > &  cam4_sample 
)
protectedvirtual

◆ checkComplete()

void VirtualView::checkComplete ( )
protected

◆ cleanupHook()

void VirtualView::cleanupHook ( )

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 VirtualView::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

◆ errorHook()

void VirtualView::errorHook ( )

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.

◆ startHook()

bool VirtualView::startHook ( )

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 VirtualView::stopHook ( )

This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

◆ updateHook()

void VirtualView::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

◆ VirtualViewBase

friend class VirtualViewBase
friend

Member Data Documentation

◆ addedCams

std::set<int> projection::VirtualView::addedCams
protected

◆ frameHelper

frame_helper::FrameHelper projection::VirtualView::frameHelper
protected

◆ hom

projection::Homography projection::VirtualView::hom
protected

◆ last_sample_ts

base::Time projection::VirtualView::last_sample_ts
protected

◆ tmpFrame

base::samples::frame::Frame projection::VirtualView::tmpFrame
protected

◆ viewFrame

RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> projection::VirtualView::viewFrame
protected

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