RTXI  2.4
The Real-Time eXperiment Interface Documentation
Public Types | Public Member Functions | Static Public Attributes
RT::Thread Class Reference

#include <rt.h>

Inheritance diagram for RT::Thread:
Inheritance graph
Collaboration diagram for RT::Thread:
Collaboration graph

Public Types

typedef unsigned long Priority
 

Public Member Functions

 Thread (Priority p=DefaultPriority)
 
virtual ~Thread (void)
 
Priority getPriority (void) const
 
virtual void execute (void)
 
bool getActive (void) const
 
void setActive (bool)
 
- Public Member Functions inherited from RT::List< T >::Node
 Node (void)
 
virtual ~Node (void)
 
bool operator== (const Node &x) const
 

Static Public Attributes

static const Priority MinimumPriority = 0
 
static const Priority MaximumPriority = 100
 
static const Priority DefaultPriority = MaximumPriority/2
 

Detailed Description

Base class for objects that are to interface with System.

See also
RT::System

Definition at line 561 of file rt.h.

Member Typedef Documentation

◆ Priority

typedef unsigned long RT::Thread::Priority

Definition at line 566 of file rt.h.

Constructor & Destructor Documentation

◆ Thread()

RT::Thread::Thread(Priority p = DefaultPriority)

Definition at line 141 of file rt.cpp.

Here is the call graph for this function:

◆ ~Thread()

RT::Thread::~Thread(void )
virtual

Definition at line 147 of file rt.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ execute()

void RT::Thread::execute(void )
inlinevirtual

Function called periodically by the realtime task.

See also
RT::System

Reimplemented in DataRecorder::Panel, and Oscilloscope::Panel.

Definition at line 598 of file rt.h.

◆ getActive()

bool RT::Thread::getActive(void )const
inline

Definition at line 600 of file rt.h.

◆ getPriority()

Priority RT::Thread::getPriority(void )const
inline

Returns the priority of the thread. The higher the priority the sooner the thread is called in the timestep.

Returns
The priority of the thread.

Definition at line 582 of file rt.h.

◆ setActive()

void RT::Thread::setActive(bool state)

Definition at line 152 of file rt.cpp.

Here is the call graph for this function:

Field Documentation

◆ DefaultPriority

const Priority RT::Thread::DefaultPriority = MaximumPriority/2
static

Definition at line 570 of file rt.h.

◆ MaximumPriority

const Priority RT::Thread::MaximumPriority = 100
static

Definition at line 569 of file rt.h.

◆ MinimumPriority

const Priority RT::Thread::MinimumPriority = 0
static

Definition at line 568 of file rt.h.


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