tobicore  7.0.0
 All Classes Functions Variables Typedefs Enumerator Friends Groups Pages
Public Member Functions | Static Public Attributes | List of all members
TCLanguage Class Reference
TOBI Core library

Language model. More...

#include <tobicore/TCLanguage.hpp>

+ Collaboration diagram for TCLanguage:

Public Member Functions

std::string Status (const int component, const int status, const int fidx=TCBlock::BlockIdxUnset)
 Creates a status message.
bool CheckVersion (const std::string &message)
 Checks if message is compatible.
bool IsStatus (const std::string &message, int *component, int *status, int *fidx)
std::string GetComponent (int component)
std::string GetStatus (int component)

Static Public Attributes

static const int IA = 1
 TOBI iA.
static const int IB = 2
 TOBI iB.
static const int IC = 3
 TOBI iC.
static const int ID = 4
 TOBI iD.
static const int Ready = 1
 Ready return code.
static const int Quit = 2
 Quit return code.
static const int ErrorGeneric = -1
 Generic error code.
static const int ErrorNotSupported = -2
 Not-supported error code.

Detailed Description

Language model.

Examples:
tclanguage.cpp.

Definition at line 29 of file TCLanguage.hpp.

Member Function Documentation

bool TCLanguage::CheckVersion ( const std::string &  message)

Checks if message is compatible.

Checks if a status message is compatible.

  • message A status message
    Returns
    True if compatible, false otherwise
Examples:
tclanguage.cpp.

Definition at line 39 of file TCLanguage.cpp.

std::string TCLanguage::GetComponent ( int  component)
  • component
  • status
  • fidx
    Returns
std::string TCLanguage::GetStatus ( int  component)
  • component
  • status
  • fidx
    Returns
bool TCLanguage::IsStatus ( const std::string &  message,
int *  component,
int *  status,
int *  fidx 
)
  • component
  • status
  • fidx
    Returns
Examples:
tclanguage.cpp.

Definition at line 45 of file TCLanguage.cpp.

+ Here is the caller graph for this function:

std::string TCLanguage::Status ( const int  component,
const int  status,
const int  fidx = TCBlock::BlockIdxUnset 
)

Creates a status message.

  • component Component ID (i.e.: iA, iB, iC...)
  • status Return code
  • fidx Frame index
    Returns
    Status message
Examples:
tclanguage.cpp.

Definition at line 28 of file TCLanguage.cpp.

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