mtsForwardDeclarations.h File Reference

Forward declarations and #define for cisstMultiTask. More...

#include <cisstCommon/cmnClassServices.h>
#include <cisstMultiTask/mtsGenericObject.h>
#include <limits>
#include <cisstMultiTask/mtsConfig.h>

Go to the source code of this file.

Classes
class	mtsCallableVoidMethod< _classType >
class	mtsCallableVoidReturnMethod< _classType, _resultType >
class	mtsCommandQueuedVoidReturnBase< _Base >
class	mtsCallableReadMethod< _classType, _resultType >
class	mtsCallableReadReturnVoidMethod< _classType, _returnType >
class	mtsCommandWrite< _classType, _argumentType >
class	mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >
class	mtsCommandQueuedWriteReturnBase< _Base >
class	mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >
class	mtsCallableQualifiedReadReturnVoidMethod< _classType, _argumentType, _resultType >
class	mtsMulticastCommandWrite< _argumentType >

Typedefs
typedef mtsCommandQueuedVoidReturnBase < mtsCommandVoidReturn >	mtsCommandQueuedVoidReturn
typedef mtsCommandQueuedVoidReturnBase < mtsCommandRead >	mtsCommandQueuedRead
typedef mtsCommandQueuedWriteReturnBase < mtsCommandWriteReturn >	mtsCommandQueuedWriteReturn
typedef mtsCommandQueuedWriteReturnBase < mtsCommandQualifiedRead >	mtsCommandQueuedQualifiedRead
typedef mtsComponent	mtsDevice
typedef unsigned int	ConnectionIDType

Enumerations
enum	mtsInterfaceQueueingPolicy { MTS_COMPONENT_POLICY, MTS_COMMANDS_SHOULD_NOT_BE_QUEUED, MTS_COMMANDS_SHOULD_BE_QUEUED }
enum	mtsCommandQueueingPolicy { MTS_INTERFACE_COMMAND_POLICY, MTS_COMMAND_QUEUED, MTS_COMMAND_NOT_QUEUED }
enum	mtsEventQueueingPolicy { MTS_INTERFACE_EVENT_POLICY, MTS_EVENT_QUEUED, MTS_EVENT_NOT_QUEUED }
enum	mtsRequiredType { MTS_OPTIONAL, MTS_REQUIRED }
enum	mtsBlockingType { MTS_BLOCKING, MTS_NOT_BLOCKING }

Functions
std::string	mtsObjectName (const void *CMN_UNUSED(object))
std::string	mtsObjectName (const mtsGenericObject *object)

Variables
const ConnectionIDType	InvalidConnectionID = (ConnectionIDType) std::numeric_limits<int>::max()

Detailed Description

Forward declarations and #define for cisstMultiTask.

Typedef Documentation

typedef unsigned int ConnectionIDType

typedef mtsCommandQueuedWriteReturnBase<mtsCommandQualifiedRead> mtsCommandQueuedQualifiedRead

typedef mtsCommandQueuedVoidReturnBase<mtsCommandRead> mtsCommandQueuedRead

typedef mtsCommandQueuedVoidReturnBase<mtsCommandVoidReturn> mtsCommandQueuedVoidReturn

typedef mtsCommandQueuedWriteReturnBase<mtsCommandWriteReturn> mtsCommandQueuedWriteReturn

typedef mtsComponent mtsDevice

Enumeration Type Documentation

enum mtsBlockingType

Type to define is a command is blocking or not

Enumerator
MTS_BLOCKING
MTS_NOT_BLOCKING

enum mtsCommandQueueingPolicy

Queueing policy, i.e. what the user would like to do for individual commands added using AddCommandVoid or AddCommandWrite as well as event handlers

Enumerator
MTS_INTERFACE_COMMAND_POLICY
MTS_COMMAND_QUEUED
MTS_COMMAND_NOT_QUEUED

enum mtsEventQueueingPolicy

Queueing policy, i.e. what the user would like to do for individual event handlers added using AddEventHandlerVoid or AddEventHandlerWrite.

Enumerator
MTS_INTERFACE_EVENT_POLICY
MTS_EVENT_QUEUED
MTS_EVENT_NOT_QUEUED

enum mtsInterfaceQueueingPolicy

Queueing policy for the interface

Enumerator
MTS_COMPONENT_POLICY
MTS_COMMANDS_SHOULD_NOT_BE_QUEUED
MTS_COMMANDS_SHOULD_BE_QUEUED

enum mtsRequiredType

Type for optional functions and interfaces

Enumerator
MTS_OPTIONAL
MTS_REQUIRED

Function Documentation

std::string mtsObjectName ( const void *  CMN_UNUSEDobject )

inline

std::string mtsObjectName ( const mtsGenericObject *  object )

inline

Variable Documentation

const ConnectionIDType InvalidConnectionID = (ConnectionIDType) std::numeric_limits<int>::max()