Simulate a FileDescriptorActivity (FDA) Primarily this is designed for unit tests that are testing components that require a FDA. More...

#include <rtt/extras/FileDescriptorSimulationActivity.hpp>

Inheritance diagram for RTT::extras::FileDescriptorSimulationActivity:

Public Types
typedef boost::shared_ptr< ActivityInterface >	shared_ptr

Public Member Functions
	FileDescriptorSimulationActivity (int priority, base::RunnableInterface *_r=0, const std::string &name="FileDescriptorSimulationActivity")

	FileDescriptorSimulationActivity (int scheduler, int priority, base::RunnableInterface *_r=0, const std::string &name="FileDescriptorSimulationActivity")

	FileDescriptorSimulationActivity (int scheduler, int priority, Seconds period, base::RunnableInterface *_r=0, const std::string &name="FileDescriptorSimulationActivity")

	FileDescriptorSimulationActivity (int scheduler, int priority, Seconds period, unsigned cpu_affinity, base::RunnableInterface *_r=0, const std::string &name="FileDescriptorSimulationActivity")

virtual	~FileDescriptorSimulationActivity ()
	Cleanup and notify the base::RunnableInterface that we are gone. More...

void	watch (int fd)
	Does nothing. More...

void	unwatch (int fd)
	Does nothing. More...

void	clearAllWatches ()
	Does nothing. More...

bool	isWatched (int fd) const
	Returns false always. More...

bool	isUpdated (int fd) const
	Return (IOReady == lastReason) More...

bool	hasTimeout () const
	Return (Timeout == lastReason) More...

bool	hasError () const
	True if one of the file descriptors has a problem (for instance it has been closed) More...

void	setTimeout (int timeout)
	Does nothing. More...

void	setTimeout_us (int timeout_us)
	Does nothing. More...

int	getTimeout () const
	Return 0. More...

int	getTimeout_us () const
	Returns 0. More...

virtual bool	start ()
	Returns true. More...

virtual bool	stop ()
	Returns true. More...

virtual bool	isRunning () const
	Returns true. More...

virtual bool	isActive () const
	Returns true. More...

virtual Seconds	getPeriod () const
	Returns period. More...

virtual bool	isPeriodic () const
	Returns true iff (0 != period) More...

virtual bool	setPeriod (Seconds s)
	If s>0 then returns true and period == s, otherwise returns false. More...

virtual unsigned	getCpuAffinity () const
	Returns 0. More...

virtual bool	setCpuAffinity (unsigned cpu)
	Returns true. More...

virtual bool	execute ()
	Returns true. More...

virtual bool	trigger ()
	Returns true. More...

virtual bool	timeout ()
	Returns true. More...

virtual os::ThreadInterface *	thread ()
	Returns os::MainThread::Instance() More...

virtual void	work (base::RunnableInterface::WorkReason reason)
	If have a runner then pass the reason to the runner and store in lastReason. More...

virtual bool	run (RunnableInterface *r)
	Run exclusively this RunnableInterface. More...

virtual RunnableInterface *	getRunner () const
	Returns a pointer to the RunnableInterface instance. More...

Protected Member Functions
void	disableRun (RunnableInterface *caller)
	This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used. More...

Protected Attributes
Seconds	period
	Fake period - some classes require period!=0. More...

bool	running

base::RunnableInterface::WorkReason	lastReason
	Value passed to last work() call Used to determine the return from isUpdated() and hasTimeout() More...

RunnableInterface *	runner

Detailed Description

Simulate a FileDescriptorActivity (FDA) Primarily this is designed for unit tests that are testing components that require a FDA.

This implementation allows deterministic cycling of such a component.

The intended use case is a component that is woken up by its FDA and then the component determines why it was woken up by calling isUpdated(), hasTimeout(), and hasError(). The unit test code should call work() with an appropriate reason, which will end up being returned to the component through the above calls. So a unit test call of work(IOReady) will result in isUpdated() returning true to the component, and similarly for work(TimeOut) and hasTimeout(). Currently hasError() always returns false - there is no way to simulate this with the current implementation.

Note: Component OwnThread operations are executed by the MainThread, which is correct for a unit test case that is directly executing.

Definition at line 58 of file FileDescriptorSimulationActivity.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<ActivityInterface> RTT::base::ActivityInterface::shared_ptr

inherited

Examples:: /home/jenkins/workspace/rtt-doc/rtt/TaskContext.hpp.

Definition at line 77 of file ActivityInterface.hpp.

Constructor & Destructor Documentation

FileDescriptorSimulationActivity::FileDescriptorSimulationActivity	(	int	priority,
		base::RunnableInterface *	_r = `0`,
		const std::string &	name = `"FileDescriptorSimulationActivity"`
	)

Definition at line 37 of file FileDescriptorSimulationActivity.cpp.

FileDescriptorSimulationActivity::FileDescriptorSimulationActivity	(	int	scheduler,
		int	priority,
		base::RunnableInterface *	_r = `0`,
		const std::string &	name = `"FileDescriptorSimulationActivity"`
	)

Definition at line 50 of file FileDescriptorSimulationActivity.cpp.

FileDescriptorSimulationActivity::FileDescriptorSimulationActivity	(	int	scheduler,
		int	priority,
		Seconds	period,
		base::RunnableInterface *	_r = `0`,
		const std::string &	name = `"FileDescriptorSimulationActivity"`
	)

Definition at line 64 of file FileDescriptorSimulationActivity.cpp.

FileDescriptorSimulationActivity::FileDescriptorSimulationActivity	(	int	scheduler,
		int	priority,
		Seconds	period,
		unsigned	cpu_affinity,
		base::RunnableInterface *	_r = `0`,
		const std::string &	name = `"FileDescriptorSimulationActivity"`
	)

Definition at line 80 of file FileDescriptorSimulationActivity.cpp.

FileDescriptorSimulationActivity::~FileDescriptorSimulationActivity ( )

virtual

Cleanup and notify the base::RunnableInterface that we are gone.

Definition at line 98 of file FileDescriptorSimulationActivity.cpp.

References stop().

Member Function Documentation

void FileDescriptorSimulationActivity::clearAllWatches ( )

virtual

Does nothing.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 117 of file FileDescriptorSimulationActivity.cpp.

void RTT::base::ActivityInterface::disableRun ( RunnableInterface * caller )

inlineprotectedinherited

This method is only meant for RunnableInterface (ie runner) in order to inform the ActivityInterface it should no longer be used.

run(0) can not be used in this case because it would recurse.

Definition at line 73 of file ActivityInterface.hpp.

Referenced by RTT::base::RunnableInterface::setActivity(), and RTT::base::RunnableInterface::~RunnableInterface().

bool FileDescriptorSimulationActivity::execute ( )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 225 of file FileDescriptorSimulationActivity.cpp.

unsigned FileDescriptorSimulationActivity::getCpuAffinity ( ) const

virtual

Returns 0.

Implements RTT::base::ActivityInterface.

Definition at line 214 of file FileDescriptorSimulationActivity.cpp.

Seconds FileDescriptorSimulationActivity::getPeriod ( ) const

virtual

Returns period.

Implements RTT::base::ActivityInterface.

Definition at line 195 of file FileDescriptorSimulationActivity.cpp.

References period.

RunnableInterface * ActivityInterface::getRunner ( ) const

virtualinherited

Returns a pointer to the RunnableInterface instance.

Definition at line 70 of file ActivityInterface.cpp.

References RTT::base::ActivityInterface::runner.

Referenced by RTT::ExecutionEngine::setActivity().

int FileDescriptorSimulationActivity::getTimeout ( ) const

virtual

Return 0.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 152 of file FileDescriptorSimulationActivity.cpp.

int FileDescriptorSimulationActivity::getTimeout_us ( ) const

virtual

Returns 0.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 157 of file FileDescriptorSimulationActivity.cpp.

bool FileDescriptorSimulationActivity::hasError ( ) const

virtual

True if one of the file descriptors has a problem (for instance it has been closed)

This should only be used from within the base::RunnableInterface this activity is driving, i.e. in TaskContext::updateHook() or TaskContext::errorHook().

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 137 of file FileDescriptorSimulationActivity.cpp.

bool FileDescriptorSimulationActivity::hasTimeout ( ) const

virtual

Return (Timeout == lastReason)

See also: work()

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 132 of file FileDescriptorSimulationActivity.cpp.

References lastReason, and RTT::base::RunnableInterface::TimeOut.

bool FileDescriptorSimulationActivity::isActive ( ) const

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 190 of file FileDescriptorSimulationActivity.cpp.

References running.

bool FileDescriptorSimulationActivity::isPeriodic ( ) const

virtual

Returns true iff (0 != period)

Implements RTT::base::ActivityInterface.

Definition at line 200 of file FileDescriptorSimulationActivity.cpp.

References period.

bool FileDescriptorSimulationActivity::isRunning ( ) const

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 185 of file FileDescriptorSimulationActivity.cpp.

References running.

bool FileDescriptorSimulationActivity::isUpdated ( int fd ) const

virtual

Return (IOReady == lastReason)

See also: work()

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 127 of file FileDescriptorSimulationActivity.cpp.

References RTT::base::RunnableInterface::IOReady, and lastReason.

bool FileDescriptorSimulationActivity::isWatched ( int fd ) const

virtual

Returns false always.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 121 of file FileDescriptorSimulationActivity.cpp.

bool ActivityInterface::run ( RunnableInterface * r )

virtualinherited

Run exclusively this RunnableInterface.

Precondition: this->isRunning() == false

Parameters

r	The RunnableInterface to run exclusively.

Returns: true if succeeded, false otherwise

Definition at line 57 of file ActivityInterface.cpp.

References RTT::base::ActivityInterface::isActive(), RTT::base::ActivityInterface::runner, and RTT::base::RunnableInterface::setActivity().

Referenced by RTT::TaskContext::setActivity().

bool FileDescriptorSimulationActivity::setCpuAffinity ( unsigned cpu )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 219 of file FileDescriptorSimulationActivity.cpp.

bool FileDescriptorSimulationActivity::setPeriod ( Seconds s )

virtual

If s>0 then returns true and period == s, otherwise returns false.

Implements RTT::base::ActivityInterface.

Definition at line 205 of file FileDescriptorSimulationActivity.cpp.

References period.

void FileDescriptorSimulationActivity::setTimeout ( int timeout )

virtual

Does nothing.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 142 of file FileDescriptorSimulationActivity.cpp.

void FileDescriptorSimulationActivity::setTimeout_us ( int timeout_us )

virtual

Does nothing.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 147 of file FileDescriptorSimulationActivity.cpp.

bool FileDescriptorSimulationActivity::start ( )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 167 of file FileDescriptorSimulationActivity.cpp.

References running.

bool FileDescriptorSimulationActivity::stop ( )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 176 of file FileDescriptorSimulationActivity.cpp.

References running.

Referenced by ~FileDescriptorSimulationActivity().

os::ThreadInterface * FileDescriptorSimulationActivity::thread ( )

virtual

Returns os::MainThread::Instance()

Implements RTT::base::ActivityInterface.

Definition at line 240 of file FileDescriptorSimulationActivity.cpp.

References RTT::os::MainThread::Instance().

bool FileDescriptorSimulationActivity::timeout ( )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 235 of file FileDescriptorSimulationActivity.cpp.

bool FileDescriptorSimulationActivity::trigger ( )

virtual

Returns true.

Implements RTT::base::ActivityInterface.

Definition at line 230 of file FileDescriptorSimulationActivity.cpp.

void FileDescriptorSimulationActivity::unwatch ( int fd )

virtual

Does nothing.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 112 of file FileDescriptorSimulationActivity.cpp.

void FileDescriptorSimulationActivity::watch ( int fd )

virtual

Does nothing.

Implements RTT::extras::FileDescriptorActivityInterface.

Definition at line 107 of file FileDescriptorSimulationActivity.cpp.

void FileDescriptorSimulationActivity::work ( base::RunnableInterface::WorkReason reason )

virtual

If have a runner then pass the reason to the runner and store in lastReason.

Definition at line 245 of file FileDescriptorSimulationActivity.cpp.

References lastReason, RTT::base::ActivityInterface::runner, and RTT::base::RunnableInterface::work().

Member Data Documentation

base::RunnableInterface::WorkReason RTT::extras::FileDescriptorSimulationActivity::lastReason

protected

Value passed to last work() call Used to determine the return from isUpdated() and hasTimeout()

Definition at line 172 of file FileDescriptorSimulationActivity.hpp.

Referenced by hasTimeout(), isUpdated(), and work().

Seconds RTT::extras::FileDescriptorSimulationActivity::period

protected

Fake period - some classes require period!=0.

Is initialized to 0

Definition at line 167 of file FileDescriptorSimulationActivity.hpp.

Referenced by getPeriod(), isPeriodic(), and setPeriod().

RunnableInterface* RTT::base::ActivityInterface::runner

protectedinherited

Definition at line 65 of file ActivityInterface.hpp.

Referenced by RTT::base::ActivityInterface::ActivityInterface(), RTT::Activity::breakLoop(), RTT::extras::SlaveActivity::execute(), RTT::extras::PeriodicActivity::finalize(), RTT::Activity::finalize(), RTT::base::ActivityInterface::getRunner(), RTT::Activity::initialize(), RTT::extras::PeriodicActivity::initialize(), RTT::Activity::loop(), RTT::base::ActivityInterface::run(), RTT::extras::SequentialActivity::start(), RTT::extras::SlaveActivity::start(), RTT::Activity::step(), RTT::extras::PeriodicActivity::step(), RTT::extras::FileDescriptorActivity::step(), RTT::extras::SequentialActivity::stop(), RTT::extras::SlaveActivity::stop(), RTT::extras::SequentialActivity::trigger(), work(), RTT::extras::PeriodicActivity::work(), RTT::Activity::work(), RTT::extras::FileDescriptorActivity::work(), and RTT::base::ActivityInterface::~ActivityInterface().

bool RTT::extras::FileDescriptorSimulationActivity::running

protected

Definition at line 169 of file FileDescriptorSimulationActivity.hpp.

Referenced by isActive(), isRunning(), start(), and stop().

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

rtt/extras/FileDescriptorSimulationActivity.hpp
rtt/extras/FileDescriptorSimulationActivity.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation