/
RT-LAB | ORCHESTRA: Functions Reference

Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

RT-LAB | ORCHESTRA: Functions Reference

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