RTTaskManager

Interface for managing real-time tasks firmware. See Real-Time Tasks for more information. More...

Static Functions
Creation Methods
static RapidVector< RTTaskManager * >	Discover ()
	Discover all active RTTaskManager instances.
static RTTaskManager *	Get (const int32_t managerId)
	Get an existing RTTaskManager by ID.
static RTTaskManager *	Create (const RTTaskManagerCreationParameters &parameters)
	Create a new RTTaskManager instance.

Functions
Globals
RapidVector< const char * >	GlobalNamesGet (const char *const libraryName=nullptr, const char *const libraryDirectory=nullptr)=0
	Get names of all global variables.
RSI::RapidCode::FirmwareValue	GlobalValueGet (int32_t offset)=0
	Read a GlobalTag by its offset. (internal use)
RSI::RapidCode::FirmwareValue	GlobalValueGet (const char *const name, const char *const libraryName=nullptr, const char *const libraryDirectory=nullptr)=0
	Read a GlobalTag by its name.
void	GlobalValueSet (const RSI::RapidCode::FirmwareValue &value, const char *const name, const char *const libraryName=nullptr, const char *const libraryDirectory=nullptr)=0
	Set the value of a GlobalTag variable.
RSI::RapidCode::RSIDataType	GlobalTypeGet (const char *const name, const char *const libraryName=nullptr, const char *const libraryDirectory=nullptr)=0
	Get the type of a GlobalTag variable.
Action
RTTask *	TaskSubmit (const RTTaskCreationParameters &parameters)=0
	Submit a new task to the manager using creation parameters.
RTTask *	TaskSubmit (RTTaskCreationParameters &&parameters)=0
	Submit a new task to the manager using move semantics.
RTTask *	TaskSubmit (const char *const functionName, const char *const libraryName=RTTaskCreationParameters::LibraryNameDefault, const char *const libraryDirectory=nullptr)=0
	Submit a new task to the manager using function and library names.
void	Shutdown ()=0
	Shutdown the RTTaskManager firmware.
Status
RapidVector< RTTask * >	TasksGet ()=0
	Get all tasks managed by this RTTaskManager.
RTTaskManagerStatus	StatusGet ()=0
	Get the current status of the manager.
Info
RTTaskManagerInfo	InfoGet ()=0
	Get information about the manager.
int32_t	IdGet ()=0
	Get the ID of the manager.
Version
const char *const	VersionGet ()
	Get the RSI RapidCode version.
int32_t	MpiVersionMajor ()
	Get the major MPI version.
int32_t	MpiVersionMinor ()
	Get the minor MPI version.
int32_t	MpiVersionRelease ()
	Get the release MPI version.
int32_t	RSIVersionMajor ()
	Get the major RSI version.
int32_t	RSIVersionMinor ()
	Get the minor RSI version.
int32_t	RSIVersionMicro ()
	Get the micro RSI version.
int32_t	RSIVersionPatch ()
	Get the patch RSI version.
int32_t	NumberGet ()
	Get the zero-based index of this object.
Errors and Exceptions
int32_t	ErrorLogCountGet ()
	Get the number of software errors in the error log.
const RsiError *const	ErrorLogGet ()
	Get the next RsiError in the log.
void	ErrorLogClear ()
	Clear the error log.
void	ThrowExceptions (bool state)
	Configure a class to throw exceptions.
const char *const	RsiErrorMessageGet (RSIErrorMessage msg)
	Get the RSI-specific error message text for a specific RSIErrorMessage.
const char *const	ErrorMessageGet (RSIErrorMessage msg)
	Get the detailed text message for an RSIErrorMessage.
bool	WarningMsgCheck (RSIErrorMessage msg)
	Check to see if an RSIErrorMessage is a warning (true) or not (false).
Tracing
void	Trace (bool state)
	Enables/Disables trace output.
void	TraceMaskOnSet (RSITrace maskOn)
	Turn on a particular trace output mask.
bool	TraceMaskOnGet (RSITrace maskOn)
	Check to see if a particular trace output mask is turned on.
void	TraceMaskOffSet (RSITrace maskOff)
	Turn off a particular trace output mask.
void	TraceMaskClear ()
	Clear the trace output mask.
void	TraceFileSet (const char *const fileName)
	Channels Tracing messages to specified file.
void	TraceFileClose ()
	Stops Logging to the file.
void	TraceInjectMessage (RSITrace traceLevel, const char *const message)
	Add a message to the Trace Log.

Description

Description:

RTTaskManager provides an interface for creating, controlling, and monitoring the real-time tasks firmware, including submitting new tasks, retrieving status information, and managing global data shared between tasks.

Definition at line 473 of file rttask.h.