ocra_recipes::ControllerClient Class Reference

#include <ControllerClient.h>

Inheritance diagram for ocra_recipes::ControllerClient:

Collaboration diagram for ocra_recipes::ControllerClient:

Public Member Functions
	ControllerClient ()
	ControllerClient (ocra::Model::Ptr derivedModelPtr, const int loopPeriod=DEFAULT_LOOP_PERIOD)
virtual	~ControllerClient ()
virtual bool	threadInit ()
virtual void	threadRelease ()
virtual void	run ()
virtual void	printHelp ()
int	getExpectedPeriod ()
virtual bool	configure (yarp::os::ResourceFinder &rf)
void	addTasks (const std::string &pathToXmlFile, bool overwrite)
void	addTask (ocra::TaskBuilderOptions &tmOpts, bool overwrite)
bool	checkIfTaskExists (ocra::TaskBuilderOptions &tmOpts)
std::vector< std::string >	getTaskTypes ()
std::vector< std::string >	getTaskNames ()
bool	removeTask (const std::string &taskName)
bool	removeTasks (const std::vector< std::string > &taskNameVector)
bool	hasBeenReleased ()
bool	changeFixedLink (std::string newFixedLink, int isInLeftSupport, int isInRightSupport)

Protected Member Functions
virtual bool	initialize ()
virtual void	release ()
virtual void	loop ()=0

Protected Attributes
ClientCommunications::Ptr	clientComs
ocra::Model::Ptr	model

Detailed Description

Definition at line 24 of file ControllerClient.h.

Constructor & Destructor Documentation

ControllerClient::ControllerClient

(

)

Definition at line 7 of file ControllerClient.cpp.

ControllerClient::ControllerClient	(	ocra::Model::Ptr	derivedModelPtr,
		const int	loopPeriod = DEFAULT_LOOP_PERIOD
	)

Definition at line 15 of file ControllerClient.cpp.

ControllerClient::~ControllerClient ( )

virtual

Definition at line 38 of file ControllerClient.cpp.

Member Function Documentation

void ocra_recipes::ControllerClient::addTask	(	ocra::TaskBuilderOptions &	tmOpts,
		bool	overwrite
	)

void ControllerClient::addTasks	(	const std::string &	pathToXmlFile,
		bool	overwrite
	)

Definition at line 78 of file ControllerClient.cpp.

bool ControllerClient::changeFixedLink	(	std::string	newFixedLink,
		int	isInLeftSupport,
		int	isInRightSupport
	)

Definition at line 138 of file ControllerClient.cpp.

bool ControllerClient::checkIfTaskExists

(

ocra::TaskBuilderOptions &

tmOpts

)

Definition at line 108 of file ControllerClient.cpp.

virtual bool ocra_recipes::ControllerClient::configure ( yarp::os::ResourceFinder &  rf )

inlinevirtual

Configures the module by parsing the RF contents.

Parameters

rf	A resource finder instance which is initialized from the command line args.

Returns

True or false if the configuration was successful.

Definition at line 47 of file ControllerClient.h.

int ocra_recipes::ControllerClient::getExpectedPeriod ( )

inline

Definition at line 40 of file ControllerClient.h.

std::vector< std::string > ControllerClient::getTaskNames

(

)

Definition at line 133 of file ControllerClient.cpp.

std::vector< std::string > ControllerClient::getTaskTypes

(

)

Definition at line 128 of file ControllerClient.cpp.

bool ocra_recipes::ControllerClient::hasBeenReleased ( )

inline

Definition at line 59 of file ControllerClient.h.

virtual bool ocra_recipes::ControllerClient::initialize ( )

inlineprotectedvirtual

Definition at line 64 of file ControllerClient.h.

virtual void ocra_recipes::ControllerClient::loop ( )

protectedpure virtual

virtual void ocra_recipes::ControllerClient::printHelp ( )

inlinevirtual

Definition at line 38 of file ControllerClient.h.

virtual void ocra_recipes::ControllerClient::release ( )

inlineprotectedvirtual

Definition at line 65 of file ControllerClient.h.

bool ControllerClient::removeTask

(

const std::string &

taskName

)

Definition at line 63 of file ControllerClient.cpp.

bool ControllerClient::removeTasks

(

const std::vector< std::string > &

taskNameVector

)

Definition at line 72 of file ControllerClient.cpp.

void ControllerClient::run ( )

virtual

Definition at line 52 of file ControllerClient.cpp.

bool ControllerClient::threadInit ( )

virtual

Definition at line 43 of file ControllerClient.cpp.

void ControllerClient::threadRelease ( )

virtual

Definition at line 57 of file ControllerClient.cpp.

Member Data Documentation

ClientCommunications::Ptr ocra_recipes::ControllerClient::clientComs

protected

Definition at line 68 of file ControllerClient.h.

ocra::Model::Ptr ocra_recipes::ControllerClient::model

protected

Definition at line 69 of file ControllerClient.h.

---

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

• ControllerClient.h
• ControllerClient.cpp