RTT::extras::IRQActivity Class Reference

#include <IRQActivity.hpp>

Inheritance diagram for RTT::extras::IRQActivity:

[legend]

List of all members.

Classes
struct	Provider
Public Member Functions
int	getIRQ () const
int	getIRQ () const
	IRQActivity (int scheduler, int priority, base::RunnableInterface *_r=0, const std::string &name="IRQActivity")
	IRQActivity (int priority, base::RunnableInterface *_r=0, const std::string &name="IRQActivity")
	IRQActivity (int scheduler, int priority, base::RunnableInterface *_r=0, const std::string &name="IRQActivity")
	IRQActivity (int priority, base::RunnableInterface *_r=0, const std::string &name="IRQActivity")
void	setIRQ (int irq)
void	setIRQ (int irq)
virtual bool	start ()
virtual bool	start ()
virtual	~IRQActivity ()
virtual	~IRQActivity ()
Private Attributes
RT_INTR	m_handle
int	m_irq
base::RunnableInterface *	m_runner

---

Detailed Description

An activity which is triggered by an IRQ edge. This activity is only available on xenomai

The IRQ line can be given by two means:

• setIRQ is called
• one of the underlying task contexts (if any) provides the Provider interface. In that case, the getIRQ() method of that task context is called to get the descriptor

Definition at line 73 of file install/include/rtt/extras/IRQActivity.hpp.

---

Constructor & Destructor Documentation

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

Create a IRQActivity with a given priority and base::RunnableInterface instance. The default scheduler for IRQActivity objects is ORO_SCHED_RT.

Parameters:

	priority	The priority of the underlying thread.
	_r	The optional runner, if none, this->loop() is called.

Definition at line 50 of file IRQActivity.cpp.

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

Create a IRQActivity with a given scheduler type, priority and base::RunnableInterface instance.

Parameters:

	scheduler	The scheduler in which the activitie's thread must run. Use ORO_SCHED_OTHER or ORO_SCHED_RT.
	priority	The priority of the underlying thread.
	_r	The optional runner, if none, this->loop() is called.

Definition at line 55 of file IRQActivity.cpp.

IRQActivity::~IRQActivity

(

)

[virtual]

Definition at line 60 of file IRQActivity.cpp.

RTT::extras::IRQActivity::IRQActivity	(	int	priority,
		base::RunnableInterface *	_r = 0,
		const std::string &	name = "IRQActivity"
	)

Create a IRQActivity with a given priority and base::RunnableInterface instance. The default scheduler for IRQActivity objects is ORO_SCHED_RT.

Parameters:

	priority	The priority of the underlying thread.
	_r	The optional runner, if none, this->loop() is called.

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

Create a IRQActivity with a given scheduler type, priority and base::RunnableInterface instance.

Parameters:

	scheduler	The scheduler in which the activitie's thread must run. Use ORO_SCHED_OTHER or ORO_SCHED_RT.
	priority	The priority of the underlying thread.
	_r	The optional runner, if none, this->loop() is called.

virtual RTT::extras::IRQActivity::~IRQActivity

(

)

[virtual]

---

Member Function Documentation

int RTT::extras::IRQActivity::getIRQ

(

)

const

int IRQActivity::getIRQ

(

)

const

Definition at line 65 of file IRQActivity.cpp.

void RTT::extras::IRQActivity::setIRQ

(

int

irq

)

void IRQActivity::setIRQ

(

int

irq

)

Definition at line 66 of file IRQActivity.cpp.

virtual bool RTT::extras::IRQActivity::start

(

)

[virtual]

Start the activity. This will call RunnableInterface::initialize() and upon success, effectively start the activity, by running the RunnableInterface::step() or RunnableInterface::loop() in a thread.

See also:

isPeriodic()

Returns:

true if the activity is started, false otherwise

Reimplemented from RTT::Activity.

bool IRQActivity::start

(

)

[virtual]

Start the activity. This will call RunnableInterface::initialize() and upon success, effectively start the activity, by running the RunnableInterface::step() or RunnableInterface::loop() in a thread.

See also:

isPeriodic()

Returns:

true if the activity is started, false otherwise

Reimplemented from RTT::Activity.

Definition at line 69 of file IRQActivity.cpp.

---

Member Data Documentation

RT_INTR RTT::extras::IRQActivity::m_handle [private]

Definition at line 76 of file install/include/rtt/extras/IRQActivity.hpp.

int RTT::extras::IRQActivity::m_irq [private]

Definition at line 75 of file install/include/rtt/extras/IRQActivity.hpp.

base::RunnableInterface * RTT::extras::IRQActivity::m_runner [private]

Definition at line 77 of file install/include/rtt/extras/IRQActivity.hpp.

---

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

• install/include/rtt/extras/IRQActivity.hpp
• rtt/extras/IRQActivity.hpp
• IRQActivity.cpp