Class Simu

Defined in File SimuApi.h

Class Documentation

class Simu

This class contains Simu API functions.

Public Functions

Simu(WMX3Api *f): Constructor to initialize an object of this class. The device created by the WMX3Api object passed to this constructor is used to execute API functions. Also see Devices.

Simu(const Simu &src): Copy constructor to initialize an object of this class based on an existing object of this class. Also see Copy Operators.

Simu &operator=(const Simu &src): Copy assignment operator to initialize an object of this class based on an existing object of this class. Also see Copy Operators.

Simu(): Constructor to initialize an object of this class with a self device. Also see Self Devices.

Simu(DeviceType::T type): Constructor to initialize an object of this class with a self device of the specified device type. Also see Self Devices.

~Simu(): Destructor for this class.

bool IsDeviceValid()

Return TRUE if this class object has access to a device, and FALSE otherwise. A device is required to execute most functions in this class. If this function returns FALSE, a device can be created by calling the CreateDevice function from the WMX3Api object that was passed to the constructor of this class.

SIMUAPIFUNC GetVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion)

Get the version of the module rtdll.

Parameters:

pMajorVersion – [out] The major version number.
pMinorVersion – [out] The minor version number.
pRevisionVersion – [out] The revision version number.
pFixVersion – [out] The fix version number.

SIMUAPIFUNC SetInBit(int byte, int bit, unsigned char data)

Set the value of a simulator input bit.

The input bit will be updated during the next communication cycle.

Remark

Parameters:

byte – [in] The byte address of the bit to set.
bit – [in] The bit offset of the bit to set.
data – [in] The value to set the bit to.

SIMUAPIFUNC SetInByte(int byte, unsigned char data)

Set the value of a simulator input byte.

The input byte will be updated during the next communication cycle.

Remark

Parameters:

byte – [in] The address of the byte to set.
data – [in] The value to set the byte to.

SIMUAPIFUNC SetInBytes(int byte, int size, unsigned char *pData)

Set the value of multiple simulator input bytes.

The input bytes will be updated during the next communication cycle.

Remark

Parameters:

byte – [in] The byte address of the head byte.
size – [in] The number of bytes to set.
pData – [in] A pointer to a char array that contains the values to set the bytes to. The size of the array must be greater than or equal to the size parameter.

SIMUAPIFUNC SetInBits(int *pByte, int *pBit, unsigned char *pData, int count)

Set the value of multiple simulator input bits.

This function is equivalent to calling the

SetInBit function multiple times, but can be faster due to the reduced overhead. There is no limit to the number of bits that may be specified at once. pByte[0], pBit[0], and pData[0] specify the first input bit to set, pByte[1], pBit[1], and pData[1] specify the second input bit to set, and so on. The bits can be specified in any order.

Remark

The input bits will be updated during the next communication cycle.

Parameters:

pByte – [in] A pointer to an int array that contains the byte addresses of the input bits. The size of the array must be equal to the count parameter.
pBit – [in] A pointer to an int array that contains the bit addresses of the input bits. The size of the array must be equal to the count parameter.
pData – [in] A pointer to an unsigned char array that contains the values to set the bits to. The size of the array must be equal to the count parameter.
count – [in] The number of bits to set.

SIMUAPIFUNC ClearInBit(int byte, int bit)

Clear the set value of a simulator input bit.

The input bit will be updated during the next communication cycle.

Remark

Parameters:

byte – [in] The byte address of the bit to clear.
bit – [in] The bit offset of the bit to clear.

SIMUAPIFUNC ClearInByte(int byte)

Clear the set value of a simulator input byte.

The input byte will be updated during the next communication cycle.

Remark

Parameters:: byte – [in] The address of the byte to clear.

SIMUAPIFUNC ClearInBytes(int byte, int size)

Clear the set value of multiple simulator input bytes.

The input bytes will be updated during the next communication cycle.

Remark

Parameters:

byte – [in] The byte address of the head byte.
size – [in] The number of bytes to clear.

SIMUAPIFUNC ClearInBits(int *pByte, int *pBit, int count)

Clear the set value of multiple simulator input bits.

This function is equivalent to calling the

ClearInBit function multiple times, but can be faster due to the reduced overhead. There is no limit to the number of bits that may be specified at once. pByte[0], pBit[0], and pData[0] specify the first input bit to clear, pByte[1], pBit[1], and pData[1] specify the second input bit to clear, and so on. The bits can be specified in any order.

Remark

The input bits will be updated during the next communication cycle.

Parameters:

pByte – [in] A pointer to an int array that contains the byte addresses of the input bits. The size of the array must be equal to the count parameter.
pBit – [in] A pointer to an int array that contains the bit addresses of the input bits. The size of the array must be equal to the count parameter.
count – [in] The number of bits to clear.

SIMUAPIFUNC SetServoOnFeedback(int axis, int newStatus)

Set the value of the “servo on feedback” signal of a simulator axis.