openjaus::model::StateMachineRunner Class Reference

This is a brief description. More...

#include <StateMachineRunner.h>

Inherits openjaus::system::Thread.

Public Member Functions
	StateMachineRunner ()
virtual	~StateMachineRunner ()
std::string	getName () const
	Accessor to get the value of name. More...
bool	setName (std::string name)
	Accessor to set value of name. More...
const system::PriorityQueue &	getQueue () const
	Accessor to get the value of queue. More...
StateMachine *	getStateMachine () const
	Accessor to get the value of stateMachine. More...
bool	setStateMachine (StateMachine *stateMachine)
	Accessor to set value of stateMachine. More...
bool	push (system::Prioritized *trigger)
	Operation push. More...
void	stop ()
	Operation stop. More...
virtual std::string	toString () const
Public Member Functions inherited from openjaus::system::Thread
	Thread ()
virtual	~Thread ()
	Thread (void *(*functionPointer)(void *), void *data)
bool	isRunning () const
	Accessor to get the value of running. More...
bool	setRunning (bool running)
	Accessor to set value of running. More...
void	create ()
	Operation create. More...
void	join ()
	Operation join. More...
void	setThreadFunction (void *(*functionPointer)(void *), void *data)

Protected Member Functions
virtual void *	run ()

Protected Attributes
std::string	name
system::PriorityQueue	queue
StateMachine *	stateMachine
bool	active
Protected Attributes inherited from openjaus::system::Thread
bool	running
pthread_t	thread
void *	data
void *(*	threadFunction )(void *)

Private Member Functions
virtual void	onCreate ()
	Method is executed when create() is called but before the Thread is created and run. More...

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const StateMachineRunner &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const StateMachineRunner *object)

Additional Inherited Members
Static Protected Member Functions inherited from openjaus::system::Thread
static void *	start (void *classPointer)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

StateMachineRunner()

openjaus::model::StateMachineRunner::StateMachineRunner

(

)

~StateMachineRunner()

openjaus::model::StateMachineRunner::~StateMachineRunner ( )

virtual

Member Function Documentation

getName()

std::string openjaus::model::StateMachineRunner::getName

(

void

)

const

getQueue()

const system::PriorityQueue & openjaus::model::StateMachineRunner::getQueue

(

)

const

getStateMachine()

StateMachine * openjaus::model::StateMachineRunner::getStateMachine

(

)

const

onCreate()

void openjaus::model::StateMachineRunner::onCreate ( )

privatevirtual

Reimplemented from openjaus::system::Thread.

push()

bool openjaus::model::StateMachineRunner::push

(

system::Prioritized *

trigger

)

Parameters

trigger

run()

void * openjaus::model::StateMachineRunner::run ( )

protectedvirtual

Reimplemented from openjaus::system::Thread.

setName()

bool openjaus::model::StateMachineRunner::setName

(

std::string

name

)

Parameters

name	The value of the new name.

setStateMachine()

bool openjaus::model::StateMachineRunner::setStateMachine

(

StateMachine *

stateMachine

)

Parameters

stateMachine

The value of the new stateMachine.

stop()

void openjaus::model::StateMachineRunner::stop

(

)

toString()

std::string openjaus::model::StateMachineRunner::toString ( ) const

virtual

Reimplemented from openjaus::system::Thread.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const StateMachineRunner &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const StateMachineRunner *  object  )

friend

Member Data Documentation

active

bool openjaus::model::StateMachineRunner::active

protected

name

std::string openjaus::model::StateMachineRunner::name

protected

queue

system::PriorityQueue openjaus::model::StateMachineRunner::queue

protected

stateMachine

StateMachine* openjaus::model::StateMachineRunner::stateMachine

protected

---

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

• include/openjaus/model/StateMachineRunner.h
• src/openjaus/model/StateMachineRunner.cpp