OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::Thread Class Reference

This is a brief description. More...

#include <Thread.h>

Inherited by openjaus::model::StateMachineRunner, and openjaus::system::Logger.

Public Member Functions

 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...
 
virtual std::string toString () const
 
void setThreadFunction (void *(*functionPointer)(void *), void *data)
 

Protected Member Functions

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

Static Protected Member Functions

static void * start (void *classPointer)
 

Protected Attributes

bool running
 
pthread_t thread
 
void * data
 
void *(* threadFunction )(void *)
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ Thread() [1/2]

openjaus::system::Thread::Thread ( )

§ ~Thread()

openjaus::system::Thread::~Thread ( )
virtual

§ Thread() [2/2]

openjaus::system::Thread::Thread ( void *(*)(void *)  functionPointer,
void *  data 
)

Member Function Documentation

§ create()

void openjaus::system::Thread::create ( )

§ isRunning()

bool openjaus::system::Thread::isRunning ( ) const

§ join()

void openjaus::system::Thread::join ( )

§ onCreate()

void openjaus::system::Thread::onCreate ( )
protectedvirtual

§ run()

virtual void* openjaus::system::Thread::run ( )
inlineprotectedvirtual

§ setRunning()

bool openjaus::system::Thread::setRunning ( bool  running)
Parameters
runningThe value of the new running.

§ setThreadFunction()

void openjaus::system::Thread::setThreadFunction ( void *(*)(void *)  functionPointer,
void *  data 
)

§ start()

void * openjaus::system::Thread::start ( void *  classPointer)
staticprotected

§ toString()

std::string openjaus::system::Thread::toString ( ) const
virtual

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ data

void* openjaus::system::Thread::data
protected

§ running

bool openjaus::system::Thread::running
protected

§ thread

pthread_t openjaus::system::Thread::thread
protected

§ threadFunction

void*(* openjaus::system::Thread::threadFunction) (void *)
protected

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