Regatron.G5.Api.System.DataExchange Class Reference

DataExchange provides methods to read and write values from/to
dedicated objects out of the ObjectDirectory of the G5 device.
The object addressing consists of a device id,
board id, object-group index and object index. More...

Public Member Functions
UInt16	ReadUInt16Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read an unsigned 16bit integer object value from the specified board.
Int16	ReadInt16Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a signed 16bit integer object value from the specified board.
UInt32	ReadUInt32Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read an unsigned 32bit integer object value from the specified board.
Int32	ReadInt32Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a signed 32bit integer object value from the specified board.
Int64	ReadInt64Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a 64 bit signed integer object value from the specified board.
UInt64	ReadUInt64Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a 64 bit unsigned integer object value from the specified board.
Single	ReadSingleValue (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a 32bit floating point object value from the specified board.
String	ReadString (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex)
	Read a string object value from the specified board.
Byte[]	ReadData (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt32 dataSize)
	Read a data object value from the specified board.
void	WriteUInt16Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt16 value)
	Write an unsigned 16bit integer object value to the specified board.
void	WriteInt16Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int16 value)
	Write a signed 16bit integer object value to the specified board.
void	WriteUInt32Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt32 value)
	Write an unsigned 32bit integer object value to the specified board.
void	WriteInt32Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int32 value)
	Write a signed 32bit integer object value to the specified board.
void	WriteInt64Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int64 value)
	Write a signed 64 bit integer object value to the specified board.
void	WriteUInt64Value (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt64 value)
	Write a unsigned 64 bit integer object value to the specified board.
void	WriteSingleValue (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Single value)
	Write a 32bit floating point object value to the specified board.
void	WriteString (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, String value)
	Write a string object value to the specified board.
void	WriteData (UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Byte[] data)
	Write a data object value to the specified board.

Detailed Description

DataExchange provides methods to read and write values from/to
dedicated objects out of the ObjectDirectory of the G5 device.
The object addressing consists of a device id,
board id, object-group index and object index.

Member Function Documentation

ReadData()

Byte[] Regatron.G5.Api.System.DataExchange.ReadData ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt32 dataSize )

inline

Read a data object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
dataSize	Number of bytes to read.

Returns

Value of type Byte[]

Exceptions

G5ApiException

ReadInt16Value()

Int16 Regatron.G5.Api.System.DataExchange.ReadInt16Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a signed 16bit integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type Int16.

Exceptions

G5ApiException

ReadInt32Value()

Int32 Regatron.G5.Api.System.DataExchange.ReadInt32Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a signed 32bit integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type Int32.

Exceptions

G5ApiException

ReadInt64Value()

Int64 Regatron.G5.Api.System.DataExchange.ReadInt64Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a 64 bit signed integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type Int32.

Exceptions

G5ApiException

ReadSingleValue()

Single Regatron.G5.Api.System.DataExchange.ReadSingleValue ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a 32bit floating point object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type Single.

Exceptions

G5ApiException

ReadString()

String Regatron.G5.Api.System.DataExchange.ReadString ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a string object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type String.

Exceptions

G5ApiException

ReadUInt16Value()

UInt16 Regatron.G5.Api.System.DataExchange.ReadUInt16Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read an unsigned 16bit integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type UInt16.

Exceptions

G5ApiException

ReadUInt32Value()

UInt32 Regatron.G5.Api.System.DataExchange.ReadUInt32Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read an unsigned 32bit integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type UInt32.

Exceptions

G5ApiException

ReadUInt64Value()

UInt64 Regatron.G5.Api.System.DataExchange.ReadUInt64Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex )

inline

Read a 64 bit unsigned integer object value from the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.

Returns

Value of type Int32.

Exceptions

G5ApiException

WriteData()

void Regatron.G5.Api.System.DataExchange.WriteData ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Byte[] data )

inline

Write a data object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
data	Data to set.

WriteInt16Value()

void Regatron.G5.Api.System.DataExchange.WriteInt16Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int16 value )

inline

Write a signed 16bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteInt32Value()

void Regatron.G5.Api.System.DataExchange.WriteInt32Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int32 value )

inline

Write a signed 32bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteInt64Value()

void Regatron.G5.Api.System.DataExchange.WriteInt64Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Int64 value )

inline

Write a signed 64 bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteSingleValue()

void Regatron.G5.Api.System.DataExchange.WriteSingleValue ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, Single value )

inline

Write a 32bit floating point object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteString()

void Regatron.G5.Api.System.DataExchange.WriteString ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, String value )

inline

Write a string object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

WriteUInt16Value()

void Regatron.G5.Api.System.DataExchange.WriteUInt16Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt16 value )

inline

Write an unsigned 16bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteUInt32Value()

void Regatron.G5.Api.System.DataExchange.WriteUInt32Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt32 value )

inline

Write an unsigned 32bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException

WriteUInt64Value()

void Regatron.G5.Api.System.DataExchange.WriteUInt64Value ( UInt16 deviceId, UInt16 boardId, UInt32 objectGroupIndex, UInt32 objectIndex, UInt64 value )

inline

Write a unsigned 64 bit integer object value to the specified board.

Parameters

deviceId	Id of the target device.
boardId	Id of the target board within the target device.
objectGroupIndex	Object group index according the G5 object directory.
objectIndex	Object index according the G5 object directory.
value	Value to set.

Exceptions

G5ApiException