Page Content

The following functions are called from within a C/C++ application to interface with RT-LAB running on a target processor.

RTActivatePrintBuffer

Group	Orchestra
Description	This function is obsolete. Activates the print buffer used to print data using the OpalPrint() function. This function MUST be called before calling OpalPrint().
Synopsis	RTAPIReturn_t RTActivatePrintBuffer(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTDeactivatePrintBuffer
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTCheckReadyToGo

Group	Orchestra
Description	Verify the ready to go condition. Connection key should be set before invoking this function.
Synopsis	RTAPIReturn_t RTCheckReadyToGo(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTGetSkipWaitToGoAtConnection, RTSetSkipWaitToGoAtConnection
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTConnect

Group	Orchestra
Description	Attaches an External Component to the memory segment corresponding to a domain. If the connection fails, the calling process goes to sleep and attempts to connect repeatedly until the timeout delay expires. To use ethernet communication, the RTConnectWithFile function must be used.
Synopsis	RTAPIReturn_t RTConnect(const char *domainName, unsigned int timeout);
Input	domainName : the name of the domain to which the connection is requested. This domain must exist in the DDF read by an RT-LAB subsystem. timeout : The duration after which a failed connection attempt times out, in seconds.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTConnectInstance, RTConnectWithFile, RTDisconnect
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTConnectInstance

Group	Orchestra
Description	Attaches an External Component to the memory segment corresponding to a domain and an instance id. If the connection fails, the calling process goes to sleep and attempts to connect repeatedly until the timeout delay expires.
Synopsis	RTAPIReturn_t RTConnectIntance(const char domainName, unsigned int timeout, const char instanceID);
Input	domainName : The name of the domain to which the connection is requested. This domain must exist in the DDF read by an RT-LAB subsystem. timeout : The duration after which a failed connection attempt times out, in seconds. instanceID : The instance identifier. If empty, this value is ignored and the function performs exactly as RTConnect.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTConnect, RTConnectWithFile, RTDisconnect
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTConnectWithFile

Group	Orchestra
Description	Attaches an External Component to the memory segment corresponding to a domain. If the connection fails, the calling process goes to sleep and attempts to connect repeatedly until the timeout delay expires.
Synopsis	RTAPIReturn_t RTConnectWithFile(const char xmlFile, const char domainName, unsigned int timeout);
Input	xmlFile : The path to the DDF file. domainName : The name of the domain to which the connection is requested. This domain must exist in the DDF read by an RT-LAB subsystem. timeout : The duration after which a failed connection attempt times out, in seconds.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTConnect, RTConnectInstance, RTDisconnect
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTDeactivatePrintBuffer

Group	Orchestra
Description	This function is obsolete Deactivates the print buffer used to print data using the OpalPrint() function.
Synopsis	RTAPIReturn_t RTDeactivatePrintBuffer(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTActivatePrintBuffer
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTDefineFlagDelay

Group	Orchestra
Description	Defines the delay to wait when using flag synchronization (XHP). It calls the system function 'usleep' and frees the CPU.
Synopsis	RTAPIReturn_t RTDefineFlagDelay(unsigned int usec);
Input	usec: delay to wait in micro second
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTUseFlagWithTool
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTDisconnect

Group	Orchestra
Description	Detaches the current process from the shared memory segment corresponding to a domain.
Synopsis	RTAPIReturn_t RTDisconnect(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTConnect, RTConnectInstance, RTConnectWithFile
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTGetConnectionKey

Group	Orchestra
Description	Gets the current connection key.
Synopsis	RTAPIReturn_t RTGetConnectionKey(unsigned int *key);
Input	None
Output	key: Key to a connection
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTNewConnectionKey, RTSetConnectionKey
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTGetErrorMessage

Group	Orchestra
Description	Retrieves the text description of an RTAPI error.
Synopsis	const char* RTGetErrorMessage(RTAPIReturn_t returnCode);
Input	returnCode: The RTAPIReturn_t error code returned by a previous RTAPI function call.
Output	None
Return Value	A pointer to a const string that contains the text description of the error.
Example	None
Related Items	RTAPIReturn_t
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTGetInfoForItem

Group	Orchestra
Description	Retrieves data item information from a locally kept offset table. This item must exist in the DDF read by an RT-LAB subsystem.
Synopsis	RTAPIReturn_t RTGetInfoForItem(const char itemName, size_tpTypeSize, unsigned short *pLength);
Input	itemName: The name of the item for which the info is retrieved.
Output	pTypeSize: Data item type size in bytes. pLength: Array length of the data item, i.e. the number of times the type is repeated.
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTGetKeyForItem
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTGetKeyForItem

Group	Orchestra
Description	Retrieves the index of a data item in a locally kept offset table. This item name must exist in the DDF read by an RT-LAB subsystem. The index is used to speed up data access.
Synopsis	RTAPIReturn_t RTGetKeyForItem(const char itemName, unsigned short pKey);
Input	itemName: The name of the item for which the key is retrieved.
Output	pKey: The key corresponding to the data item.
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTPublishByKey, RTSubscribeByKey
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTGetSkipWaitToGoAtConnection

Group	Orchestra
Description	Retrieves the current WaitToGo setting of the model. Non-zero value: ignore the WaitToGo during the connection step. Zero value: performs the WaitToGo during the connection step.
Synopsis	RTAPIReturn_t RTGetSkipWaitToGoAtConnection(unsigned int *flag);
Input	None
Output	flag: Pointer to receive the current WaitToGo setting.
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTSetSkipWaitToGoAtConnection
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTNewConnectionKey

Group	Orchestra
Description	Creates a new connection key. A connection key identifies a connection between a specific combo of Orchestra’s framework and client. This function must be called before any configuration function like RTSetupRefMemRemoteConnection and before RTConnect.
Synopsis	RTAPIReturn_t RTNewConnectionKey(unsigned int *key);
Input	None
Output	key: Key to be set to use this connection.
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTSetConnectionKey, RTGetConnectionKey
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTPublish

Group	Orchestra
Description	Writes data to the shared memory segment attached to the current process. To ensure proper synchronization between a publisher and a subscriber exchanging data through a domain, a call to RTPublish() MUST appear between a call to RTPublishLock() and a call to RTPublishUnlock().
Synopsis	RTAPIReturn_t RTPublish(unsigned int num, ...);
Input	num: The number of data items that are written to the memory segment. At least one (name, value) pair is required. itemName: Name of the item from the domain. value: Value to be published for the corresponding ‘itemName’. There must be as many parameters ‘itemName' and ‘value’ as specified by the parameter 'num’. See the example below for usage.
Output	None
Return Value	See RTAPIReturn_t error code
Example	RTPublish(1, "item01", &value01); RTPublish(2, "item01", &value01, "item02", &value02);
Related Items	RTSubscribe, RTPublishLock, RTPublishUnlock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTPublishByKey

Group	Orchestra
Description	Writes data to the shared memory segment attached to the current process. The key corresponding to the item of interest is obtained by calling RTGetKeyForItem(). To ensure proper synchronization between a publisher and a subscriber exchanging data through a domain, a call to RTPublishByKey() MUST appear between a call to RTPublishLock() and a call to RTPublishUnlock().
Synopsis	RTAPIReturn_t RTPublishByKey(unsigned short key, void *value);
Input	key: Index in the offset table. value: The value to publish.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTGetKeyForItem, RTPublishLock, RTPublishUnlock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTPublishLock

Group	Orchestra
Description	Sets a publish (write) lock for synchronous access to a domain.
Synopsis	RTAPIReturn_t RTPublishLock(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTPublishUnlock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTPublishUnlock

Group	Orchestra
Description	Releases a publish (write) lock.
Synopsis	RTAPIReturn_t RTPublishUnlock(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTPublishLock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSetConnectionKey

Group	Orchestra
Description	Sets a connection key created by RTNewConnectionKey. Any Orchestra related function called after this function will use this connection key, i.e., any manipulation of data and states will refer to the corresponding combo of Orchestra’s framework and client. This function has to be called again for every connection’s switch.
Synopsis	RTAPIReturn_t RTSetConnectionKey(unsigned int key);
Input	key: Key to a connection
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTNewConnectionKey, RTGetConnectionKey
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSetSkipWaitToGoAtConnection

Group	Orchestra
Description	Sets the WaitToGo setting of the model. Non-zero value: ignores the WaitToGo during the connection step. Zero value: performs the WaitToGo during the connection step.
Synopsis	RTAPIReturn_t RTSetSkipWaitToGoAtConnection(unsigned int flag);
Input	flag: Integer value to set the current WaitToGo setting.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTGetSkipWaitToGoAtConnection
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSetupRefMemRemoteConnection

Group	Orchestra
Description	This function is used to set up a remote connection to an RT-LAB framework by means of a reflective memory card.
Synopsis	RTAPIReturn_t RTSetupRefMemRemoteConnection(const char *cardName, unsigned int pciIndex);
Input	cardName: The name of the reflective memory card used to remotely connect to the framework. pciIndex: The index assigned to the card when the PCI bus is scanned. If there is only one memory card present, this index must be zero.
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTConnect
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSubscribe

Group	Orchestra
Description	Reads from the shared memory segment attached to the current process. To ensure proper synchronization between a publisher and a subscriber exchanging data through a domain, a call to RTSubscribe() MUST appear between a call to RTSubscribeLock() and a call to RTSubscribeUnlock().
Synopsis	RTAPIReturn_t RTSubscribe(unsigned int num, ...);
Input	num: The number of data items that are read from the memory segment. At least one (name, value) pair is required. itemName: Name of the item from the domain.
Output	value: Data value of the corresponding 'itemName' suscribed to. There must be as many ‘itemName' and ‘value’ parameters as specified by the parameter 'num’. See the example below for usage.
Return Value	See RTAPIReturn_t error code
Example	RTSubscribe(1, "item01", &value01); RTSubscribe(2, "item01", &value01, "item02", &value02);
Related Items	RTPublish, RTSubscribeLock, RTSubscribeUnlock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSubscribeByKey

Group	Orchestra
Description	Reads from the shared memory segment attached to the current process. The key corresponding to the item of interest is obtained by calling RTGetKeyForItem(). To ensure proper synchronization between a publisher and a subscriber exchanging data through a domain, a call to RTSubscribeByKey() MUST appear between a call to RTSubscribeLock() and a call to RTSubscribeUnlock().
Synopsis	RTAPIReturn_t RTSubscribeByKey(unsigned short key, void *value);
Input	key: Index in the offset table.
Output	value: The subscribed value.
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTGetKeyForItem
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSubscribeLock

Group	Orchestra
Description	Sets a subscribe (read) lock for synchronous access to a domain.
Synopsis	RTAPIReturn_t RTSubscribeLock(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTSubscribeUnlock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTSubscribeUnlock

Group	Orchestra
Description	Releases a subscribe (read) lock.
Synopsis	RTAPIReturn_t RTSubscribeUnlock(void);
Input	None
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTSubscribeLock
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTUseFlagWithTool

Group	Orchestra
Description	Forces the local Orchestra communication to be made with flags instead of semaphores when using an external communication process. Flags are recommended for better performance. Defines the delay to wait. It calls the system function 'usleep' and frees the CPU.
Synopsis	RTAPIReturn_t RTUseFlagWithTool(unsigned int usec);
Input	usec: delay to wait in micro second
Output	None
Return Value	See RTAPIReturn_t error code
Example	None
Related Items	RTDefineFlagDelay
Library and Header		Windows	OPAL-RTLinux
	Static Library	-	-
	Dynamic Library	OpalOchestra.dll OpalOrchestra_64.dll OpalOrchestraVISA.dll	libOpalOrchestra.so
	Header File	RTAPI.h	RTAPI.h

RTAPIReturn_t

Description
Error codes returned by the Orchestra RTAPI - A text version is obtained by calling the function RTGetErrorMessage().
Usage

typedef enum{
RTAPI_SUCCESS = 0,
RTAPI_CONNECT_FAILED_TIMEOUT,
RTAPI_CONNECT_FAILED_SHARED_MEMORY_FAILURE,
RTAPI_CONNECT_FAILED_INVALID_DOMAIN_NAME,
RTAPI_CONNECT_FAILED_INVALID_VERSION,
RTAPI_CONNECT_FAILED_ALREADY_CONNECTED,
RTAPI_CONNECT_FAILED_ANOTHER_SYNCHRONOUS_CONNECTION_EXISTS,
RTAPI_CONNECT_FAILED_INVALID_CARD,
RTAPI_CONNECT_FAILED_CARD_NOT_FOUND,
RTAPI_CONNECT_FAILED_CARD_INITIALIZATION_ERROR,
RTAPI_CONNECT_FAILED_CARD_INIT_VISA_SYSTEM_ERROR,
RTAPI_CONNECT_FAILED_CARD_FIND_PCI_RESSOURCE_ERROR,
RTAPI_CONNECT_FAILED_CARD_OPEN_PCI_RESSOURCE_ERROR,
RTAPI_CONNECT_FAILED_CARD_MAPPING_PCI_RESSOURCE_ERROR,
RTAPI_CONNECT_FAILED_CARD_ENABLE_PCI_INTERRUPT_ERROR,
RTAPI_CONNECT_FAILED_MEMORY_ALLOCATION_ERROR,
RTAPI_CONNECT_NO_CONNECTION_AVAILABLE,
RTAPI_DISCONNECT_FAILED_NOT_CONNECTED,
RTAPI_PUBLISH_FAILED_NOT_CONNECTED,
RTAPI_PUBLISH_FAILED_RTLAB_SUBSYSTEM_UNMAPPED,
RTAPI_PUBLISH_FAILED_INVALID_ITEM_LIST,
RTAPI_PUBLISH_FAILED_INVALID_KEY,
RTAPI_PUBLISH_FAILED_NEED_SUBSCRIBE_FIRST,
RTAPI_PUBLISH_FAILED_NO_MULTIPLE_PUBLISHERS_ALLOWED,
RTAPI_SUBSCRIBE_FAILED_NOT_CONNECTED,
RTAPI_SUBSCRIBE_FAILED_RTLAB_SUBSYSTEM_UNMAPPED,
RTAPI_SUBSCRIBE_FAILED_NEED_PUBLISH_FIRST,
RTAPI_SUBSCRIBE_FAILED_INVALID_ITEM_LIST,
RTAPI_SUBSCRIBE_FAILED_INVALID_KEY,
RTAPI_GETKEY_FAILED_INVALID_ITEM_NAME,
RTAPI_GETINFO_FAILED_INVALID_ITEM_NAME,
RTLOCK_FAILED_NOT_CONNECTED,
RTLOCK_FAILED_TIMEOUT,
RTAPI_RFM_WRITE_ERROR,
RTAPI_RFM_READ_ERROR,
RTACTIVATEPRINTBUFFER_FAILED_NOT_CONNECTED,
RTACTIVATEPRINTBUFFER_FAILED_COULD_NOT_ATTACH_TO_BUFFER,
RTDEACTIVATEPRINTBUFFER_FAILED_NOT_CONNECTED,
RTAPI_GETINSTANCEID_CONTAINER_IS_SMALL,
RTAPI_GETINSTANCEID_CONTAINER_IS_NULL,
RTAPI_PATH_EXCEEDS_MAX_SIZE,
RTAPI_NAME_EXCEEDS_MAX_SIZE,
RTAPI_FAILED_XML_PARSING,
RTAPI_FAILED_STARTING_COMMUNICATION_PROCESS,
RTAPI_UNKNOWN_ERROR,
RTAPI_WAIT_TO_GO_READY,
RTAPI_WAIT_TO_GO_WAIT
} RTAPIReturn_t;

Elements

RTAPI_SUCCESS (0) Function call successful.
RTAPI_CONNECT_FAILED_TIMEOUT (1) The memory segment is not accessible.
RTAPI_CONNECT_FAILED_SHARED_MEMORY_FAILURE (2) Could not attach to the shared memory
segment.
RTAPI_CONNECT_FAILED_INVALID_DOMAIN_NAME (3) Domain name argument is not defined in the
DDF.
RTAPI_CONNECT_FAILED_INVALID_VERSION (4) Invalid version between proxy and external
component.
RTAPI_CONNECT_FAILED_ALREADY_CONNECTED (5) Connection has already been established.
RTAPI_CONNECT_FAILED_ANOTHER_SYNCHRONOUS_CONNECTION_EXISTS (6) Another simulation component has already
established a synchronous connection.
RTAPI_CONNECT_FAILED_INVALID_CARD (7) Invalid or unsupported reflective memory
card name.
RTAPI_CONNECT_FAILED_CARD_NOT_FOUND (8) Reflective memory card could not be
detected.
RTAPI_CONNECT_FAILED_CARD_INITIALIZATION_ERROR (9) Reflective memory card could not be
initialized.
RTAPI_CONNECT_FAILED_CARD_INIT_VISA_SYSTEM_ERROR (10) Failed to open VISA system.
RTAPI_CONNECT_FAILED_CARD_FIND_PCI_RESSOURCE_ERROR (11) Failed to find RFM card in VISA PCI resources.
RTAPI_CONNECT_FAILED_CARD_OPEN_PCI_RESSOURCE_ERROR (12) Error during initialization of PCI RFM card.
RTAPI_CONNECT_FAILED_CARD_MAPPING_PCI_RESSOURCE_ERROR (13) Error during memory mapping of RFM card.
RTAPI_CONNECT_FAILED_CARD_ENABLE_PCI_INTERRUPT_ERROR (14) Failed to enabling interrupts on RFM card.
RTAPI_CONNECT_FAILED_MEMORY_ALLOCATION_ERROR (15) Error to allocate memory while connecting.
RTAPI_CONNECT_NO_CONNECTION_AVAILABLE (16) No more connection to proxy is available (no
more connection key).
RTAPI_DISCONNECT_FAILED_NOT_CONNECTED (17) Connection has not previously been
established.
RTAPI_PUBLISH_FAILED_NOT_CONNECTED (18) Connection has not been previously
established.
RTAPI_PUBLISH_FAILED_RTLAB_SUBSYSTEM_UNMAPPED (19) Connection to the Orchestra framework has
been lost.
RTAPI_PUBLISH_FAILED_INVALID_ITEM_LIST (20) Invalid number of items, or invalid item
name.
RTAPI_PUBLISH_FAILED_INVALID_KEY (21) Invalid item key.
RTAPI_PUBLISH_FAILED_NEED_SUBSCRIBE_FIRST (22) Connected simulation component doesn’t
have states, cannot publish frst.
RTAPI_PUBLISH_FAILED_NO_MULTIPLE_PUBLISHERS_ALLOWED (23) The Quality Of Service attributes for the
current domain indicate that only one
publisher is allower.
RTAPI_SUBSCRIBE_FAILED_NOT_CONNECTED (24) Connection has not been previously
established.
RTAPI_SUBSCRIBE_FAILED_RTLAB_SUBSYSTEM_UNMAPPED (25) Connection to the Orchestra framework has
been lost.
RTAPI_SUBSCRIBE_FAILED_NEED_PUBLISH_FIRST (26) Connected simulation component has states,
therefor it cannot subscribe frst.
RTAPI_SUBSCRIBE_FAILED_INVALID_ITEM_LIST (27) Invalid number of items, or invalid item
name.
RTAPI_SUBSCRIBE_FAILED_INVALID_KEY (28) Invalid item key.
RTAPI_GETKEY_FAILED_INVALID_ITEM_NAME (29) Item lookup failed, invalid item name.
RTAPI_GETINFO_FAILED_INVALID_ITEM_NAME (30) Item data information retrieval failed, invalid
item name.
RTLOCK_FAILED_NOT_CONNECTED (31) Locking/unlocking failed, connection has not
been previously established.
RTLOCK_FAILED_TIMEOUT (32) Timout waiting for the lock.
RTAPI_RFM_WRITE_ERROR (33) Failed to write data in RFM card.
RTAPI_RFM_READ_ERROR (34) Failed to read data in RFM card.
RTACTIVATEPRINTBUFFER_FAILED_NOT_CONNECTED (35) Connection to the Orchestra framework has
not been previously established.
RTACTIVATEPRINTBUFFER_FAILED_COULD_NOT_ATTACH_TO_BUFFER (36) Could not establish a connection with the
OpalPrint buffer.
RTDEACTIVATEPRINTBUFFER_FAILED_NOT_CONNECTED (37) Connection to the Orchestra framework has
not been previously established.
RTAPI_NAME_EXCEEDS_MAX_SIZE (41) Provided instanceID is too long,
RTAPI_FAILED_XML_PARSING (42) DDF file couldn't be parsed correctly,
RTAPI_FAILED_STARTING_COMMUNICATION_PROCESS (43) External communication process was not started correctly - 
the whole Orchestra process might need to be reset,
RTAPI_UNKNOWN_ERROR (44) Failed with unknown error,
RTAPI_WAIT_TO_GO_READY (45) Domain is connected and either asynchronous or synchronous with synchronization
mechanism operational,
RTAPI_WAIT_TO_GO_WAIT (46) Domain may not be connected or synchronous with unresponding 
synchonization mechanism.

Examples
None
Related Items
RTGetErrorMessage
Library and Header

	WINDOWS	OPAL-RTLinux

WINDOWS

OPAL-RTLinux

Static Library

-

Dynamic Library

OpalOrchestra.dll

OpalOrchestra_64.dll

OpalOrchestraVISA.dll

libOpalOrchestra.so

Header File

RTAPI.h

Enumerations and constants

The enumeration RTAPIReturn_t contains the list of error codes returned by the RT-LAB Orchestra API.

RT-LAB Documentation

RT-LAB | ORCHESTRA: Functions Reference

Page Content

RTActivatePrintBuffer

RTCheckReadyToGo

RTConnect

RTConnectInstance

RTConnectWithFile

RTDeactivatePrintBuffer

RTDefineFlagDelay

RTDisconnect

RTGetConnectionKey

RTGetErrorMessage

RTGetInfoForItem

RTGetKeyForItem

RTGetSkipWaitToGoAtConnection

RTNewConnectionKey

RTPublish

RTPublishByKey

RTPublishLock

RTPublishUnlock

RTSetConnectionKey

RTSetSkipWaitToGoAtConnection

RTSetupRefMemRemoteConnection

RTSubscribe

RTSubscribeByKey

RTSubscribeLock

RTSubscribeUnlock

RTUseFlagWithTool

RTAPIReturn_t

Elements

Enumerations and constants

RT-LAB | ORCHESTRA: Functions Reference

Page Content.css-779anb{display:inline;outline:none;background-color:transparent;border:none;color:var(--ds-icon, #42526E);cursor:pointer;right:0;}

RTActivatePrintBuffer

RTCheckReadyToGo

RTConnect

RTConnectInstance

RTConnectWithFile

RTDeactivatePrintBuffer

RTDefineFlagDelay

RTDisconnect

RTGetConnectionKey

RTGetErrorMessage

RTGetInfoForItem

RTGetKeyForItem

RTGetSkipWaitToGoAtConnection

RTNewConnectionKey

RTPublish

RTPublishByKey

RTPublishLock

RTPublishUnlock

RTSetConnectionKey

RTSetSkipWaitToGoAtConnection

RTSetupRefMemRemoteConnection

RTSubscribe

RTSubscribeByKey

RTSubscribeLock

RTSubscribeUnlock

RTUseFlagWithTool

RTAPIReturn_t

Elements

Enumerations and constants

Page Content