OpenViBE Namespace Reference

Main OpenViBE namespace. More...

Namespaces

 Kernel
 Kernel specifications of the OpenViBE platform.
 
 Plugins
 Plugins specifications of the OpenViBE platform.
 

Classes

class  CIdentifier
 Globally used identification classThis class is the basic class to use in order to identify objects in the OpenViBE platform. It can be used for class identification, for object identification and any user needed identification process. More...
 
class  CMatrix
 Basic standalone OpenViBE matrix implementationThis class offers a basic standalone impementation of the OpenViBE::IMatrix interface. This class can be directly instanciated and used. More...
 
class  CMemoryBuffer
 Basic standalone OpenViBE memory buffer implementationThis class offers a basic standalone impementation of the OpenViBE::IMemoryBuffer interface. This class can be directly instanciated and used. More...
 
class  CNameValuePairList
 This class handles a list of name/value pairs. It handles a (hidden) map associating string keys to string values.This class avoids the need to include stl's map header file in the C++ interface, thus preventing potential compile/link errors when dynamically loading modules. More...
 
class  CObservable
 OpenViBE Observable class. More...
 
class  CommandFileParser
 Parser implementation that parses command a fileThe current implementation retrieves the list of commands from a file. More...
 
class  CommandLineOptionParser
 Parser implementation that parses command from command-line argumentsThe current implementation retrieves the options from a ProgramOptions parser and simply builds the commands from the parsed options. More...
 
class  CStimulationSet
 Basic standalone OpenViBE stimulation set implementationThis class offers a basic standalone impementation of the OpenViBE::IStimulationSet interface. This class can be directly instanciated and used. More...
 
class  CString
 String class to avoid std::string in the interfaceThis class helps avoiding std::string being present in exposed C++ interface, eventually resulting in compile/link errors when dynamically loading modules. More...
 
struct  ICommand
 Base abstract struct for commandsA command is an object that encapsulates all necessary information to perform an action later one. Typically, a command implementation should contain an implementation of CommandInterface interface, and a list of properties. More...
 
class  ICommandParser
 Base abstract class for command parserCommand parsers aim at parsing a list of commands from a specific input. More...
 
class  IKernelLoader
 This class allows an OpenViBE application to load a kernel module. More...
 
class  IMatrix
 Basic OpenViBE matrix interface. More...
 
class  IMemoryBuffer
 Basic OpenViBE memory buffer interface. More...
 
struct  InitCommand
 Command that drives the initialization of the toolInitCommand class contains the following properties: More...
 
class  IObject
 Base class for all the OpenViBE platform objects. More...
 
class  IObserver
 OpenViBE Observer interface. More...
 
class  IStimulationSet
 Basic OpenViBE stimulation set interface. More...
 
class  KernelFacade
 Wrapper class used to access Kernel featuresThis class is one-to-many interface used as a central point to access a subset of Kernel features. More...
 
struct  LoadKernelCommand
 Command that drives kernel loadingLoadKernelCommand contains the following properties: More...
 
struct  LoadScenarioCommand
 Command that drives scenario loadingLoadScenarioCommand contains the following properties: More...
 
class  ProgramOptions
 Command-line options parserThis class is a basic class used to parse program options. Input format requirements: More...
 
struct  ProgramOptionsTraits
 Helper class for ProgramOptions type checkingThis class provides aliases to types currently handled by ProgramOptions class as well as type checking meta-programming features. More...
 
struct  ResetCommand
 Command that drives tool reset to its initial state. More...
 
struct  RunScenarioCommand
 Command that drives the execution of a list of scenariosRunScenarioCommand contains the following properties: More...
 
struct  SetupScenarioCommand
 Command that drives the setup of a scenarioSetupScenarioCommand contains the following properties: More...
 

Enumerations

Functions

template<typename Callback , typename std::enable_if< std::is_same< bool, typename std::result_of< Callback()>::type >::value >::type * = nullptr>
bool translateException (Callback &&callable, ExceptionHandlerType exceptionHandler)
 Invokes code and potentially translates exceptions to boolean. More...
 
boolean operator== (const CIdentifier &rIdentifier1, const CIdentifier &rIdentifier2)
 
boolean operator!= (const CIdentifier &rIdentifier1, const CIdentifier &rIdentifier2)
 
boolean operator< (const CIdentifier &rIdentifier1, const CIdentifier &rIdentifier2)
 
boolean operator> (const CIdentifier &rIdentifier1, const CIdentifier &rIdentifier2)
 
const CString operator+ (const CString &rString1, const CString &rString2)
 
boolean operator== (const CString &rString1, const CString &rString2)
 
boolean operator!= (const CString &rString1, const CString &rString2)
 
boolean operator< (const CString &rString1, const CString &rString2)
 

Detailed Description

Main OpenViBE namespace.

Author
Yann Renard (INRIA/IRISA)
Date
2006-06 All the classes defined in the OpenViBE platform are included in this namespace, including kernel and plugins.

Enumeration Type Documentation

enum PlayerReturnCode
strong
Enumerator
Success 

No error during execution

InvalidArg 

Invalid command-line options

MissingMandatoryArgument 

A mandatory argument is missing

BadArg 

An argument is given with a wrong value

OpeningFileFailure 

A file could not be opened

ParsingCommandFailure 

General parsing command error

UnkownFailure 

Error of unknown type

KernelLoadingFailure 

Kernel loading failed

KernelInvalidDesc 

Invalid kernel descriptor

KernelInvalidContext 

Invalid kernel context

KernelInternalFailure 

Generic error type for kernel internal error

ScenarioNotLoaded 

Error triggered when an action is requested on an unknown scenario

Function Documentation

bool OpenViBE::translateException ( Callback &&  callable,
ExceptionHandlerType  exceptionHandler 
)

Invokes code and potentially translates exceptions to boolean.

Template Parameters
Callbackcallable type (e.g. functor) with Callback() returning boolean
Parameters
callablecode that must be guarded against exceptions
exceptionHandlercallback that handles the exception
Returns
false either if callable() returns false or an exception occurs, true otherwise

This method is a specific exception-to-boolean translation method. If an exception is caught, it is handled by calling the provided exception handler.

boolean OpenViBE::operator== ( const CIdentifier rIdentifier1,
const CIdentifier rIdentifier2 
)
Parameters
rIdentifier1[in] : the first identifier to compare
rIdentifier2[in] : the second identifier to compare
Returns
true if the two identifiers are equal,
false if the two identifiers are different

Compares both 32 bits parts of the two identifiers and checks if those are equal or not.

See also
operator!=

References CIdentifier::m_ui64Identifier.

boolean OpenViBE::operator!= ( const CIdentifier rIdentifier1,
const CIdentifier rIdentifier2 
)
Parameters
rIdentifier1[in] : the first identifier to compare
rIdentifier2[in] : the second identifier to compare
Returns
true if the two identifiers are different,
false if the two identifiers are equal

Compares both 32 bits parts of the two identifiers and checks if those are equal or not.

See also
operator==
boolean OpenViBE::operator< ( const CIdentifier rIdentifier1,
const CIdentifier rIdentifier2 
)
Parameters
rIdentifier1[in] : the first identifier to compare
rIdentifier2[in] : the second identifier to compare
Returns
true if the first identifier is less than the second one
false if the first identifier is greater or equal to the second one

Compares both 32 bits parts of the two identifiers.

See also
operator>
operator==

References CIdentifier::m_ui64Identifier.

boolean OpenViBE::operator> ( const CIdentifier rIdentifier1,
const CIdentifier rIdentifier2 
)
Parameters
rIdentifier1[in] : the first identifier to compare
rIdentifier2[in] : the second identifier to compare
Returns
true if the first identifier is greater than the second one
false if the first identifier is less or equal to the second one

Compares both 32 bits parts of the two identifiers.

See also
operator<
operator==

References CIdentifier::m_ui64Identifier.

const CString OpenViBE::operator+ ( const CString rString1,
const CString rString2 
)
Parameters
rString1[in] : The first part of the resulting string
rString2[in] : The second part of the resulting string
Returns
The concatenation of rString1 and rString2.

References CString::m_pStringImpl.

boolean OpenViBE::operator== ( const CString rString1,
const CString rString2 
)
Parameters
rString1[in] : The first part of the resulting string
rString2[in] : The second part of the resulting string
Returns
true is rString1 is exactly rString2.
false in other case.
Note
This is case sensitive !

References CString::m_pStringImpl.

boolean OpenViBE::operator!= ( const CString rString1,
const CString rString2 
)
Parameters
rString1[in] : The first part of the resulting string
rString2[in] : The second part of the resulting string
Returns
false is rString1 is exactly rString2.
true in other case.
Note
This is case sensitive !

References CString::m_pStringImpl.

boolean OpenViBE::operator< ( const CString rString1,
const CString rString2 
)
Parameters
rString1[in] : The first part of the resulting string
rString2[in] : The second part of the resulting string
Returns
false is rString1 is exactly rString2.
true in other case.
Note
This is case sensitive !

References CString::m_pStringImpl.