Represents an item of strongly-typed data that can be read from or written to an FSUIPC offset. More...

Inherits Offset.

Public Member Functions
	Offset (int Address)
	Creates a new Offset that will read from or write to the specified Offset.

	Offset (string DataGroupName, int Address)
	Creates a new Offset in the specified Group that will read from or write to the specified Offset.

	Offset (int Address, int ArrayOrStringLength)
	Creates a Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

	Offset (int Address, bool WriteOnly)
	Creates a new Offset that will read from or write to the specified Offset.

	Offset (string DataGroupName, int Address, bool WriteOnly)
	Creates a new Offset in the specified Group that will read from or write to the specified Offset.

	Offset (int Address, int ArrayOrStringLength, bool WriteOnly)
	Creates a new Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

	Offset (string DataGroupName, int Address, int ArrayOrStringLength)
	Creates a new Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

	Offset (string DataGroupName, int Address, int ArrayOrStringLength, bool WriteOnly)
	Creates a new Offset in the specified group that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

override void	SetValue (object NewValue)
	Sets the value of the offset.

override string	ToString ()
	Return a string value containing information about this Offset.

Public Member Functions inherited from Offset
	Offset (int Address, int Length)
	Creates a Offset that will read from or write the specified number of bytes to the specified Offset.

	Offset (int Address, int Length, bool WriteOnly)
	Creates a new Offset that will read from or write the specified number of bytes to the specified Offset.

	Offset (string DataGroupName, int Address, int Length)
	Creates a new Offset that will read from or write the specified number of bytes to the specified Offset.

	Offset (string DataGroupName, int Address, int Length, bool WriteOnly)
	Creates a new Offset in the specified group that will read from or write the specified number of bytes to the specified Offset.

void	Disconnect ()
	Immediately disconnects this Offset from FSUIPC. The value of this Offset will no longer be updated or written during Process() calls. Use Reconnect() to start updating again.

void	Disconnect (bool AfterNextProcess)
	Disconnects this Offset from the FSUIPCConnection class. The value of this Offset will no longer be updated or written during Process() calls. Use Reconnect() to start updating again.

void	Reconnect ()
	Permanently reconnects this Offset to FSUIPC. The value of this Offset will be read/written during subsequent Process() calls.

void	Reconnect (bool ForNextProcessOnly)
	Reconnects this Offset to FSUIPC. The value of this Offset will be updated/written during subsequent Process() calls.

T	GetValue< T > ()
	Gets the value of this offset as the specified type.

object	GetValue (Type AsType)
	Gets the value of this offset as the specified type.

override string	ToString ()
	Return a string value containing information about this Offset.

Properties
T	Value `[get, set]`
	The strongly-typed value of this offset.

Properties inherited from Offset
int	Address `[get, set]`
	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.

OffsetAction	ActionAtNextProcess `[get, set]`
	This property can be used to force this offset to be read or written on the next process.

bool	IsConnected `[get]`
	Indicates if this Offset is currently 'Connected'. Offsets that are disconnected will not be updated or have changes written to FSUIPC when Process() is run. This is read-only. To connect or disconnect an Offset call the Connect() or Disconnect() methods.

bool	WriteOnly `[get, set]`
	Indicates that this Offset is to be Write-Only. While marked as Write-Only the value of this Offset will never be read from FSUIPC. If you change the value of this Offset the new value will be written to FSUIPC on the next process.

bool	IsFixedLengthString `[get, set]`
	True is this offset represents a fixed length string.

bool	ValueChanged `[get]`
	Indicates if the value of this Offset was changed during the last Process() call.

int	DataLength `[get]`
	The length of the data in this offset in bytes.

Guid	ID `[get]`
	The unique internal ID of this offset.

Detailed Description

Represents an item of strongly-typed data that can be read from or written to an FSUIPC offset.

Template Parameters

T	The native (.NET) type representing the data held in the FSUIPC offset.

Native .NET types supported are: Byte, SByte, Int16, UInt16, Int32, UInt32, Int64, UInt64, Double, Single, String, BitArray, FsLongitude, FsLatitude

Depending on the language you are using there may be other ways of referring to these base types.

E.g. Int16 in VB.NET is also 'Short'. In C# it's 'short'.

To read/Write raw bytes of any length from FSUIPC use an array of Bytes. (Byte() in VB.NET, byte[] in C#)

Member Function Documentation

◆ Offset() [1/8]

Offset ( int Address )

inline

Creates a new Offset that will read from or write to the specified Offset.

Parameters

Address The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.

◆ Offset() [2/8]

Offset	(	int	Address,
		bool	WriteOnly )

inline

Creates a new Offset that will read from or write to the specified Offset.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
WriteOnly	If true, Sets this Offset to only write data. Its value is never read from FSUIPC. You can change the setting with the WriteOnly property at any time.

◆ Offset() [3/8]

Offset	(	int	Address,
		int	ArrayOrStringLength )

inline

Creates a Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
ArrayOrStringLength	The number of bytes to read. Used to define the length of types: String, BitArray, FsBitArray, FsLongitude, FsLatitude and array of bytes. Use a negative length for strings without 0 terminators.

◆ Offset() [4/8]

Offset	(	int	Address,
		int	ArrayOrStringLength,
		bool	WriteOnly )

inline

Creates a new Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
ArrayOrStringLength	The number of bytes to read. Used to define the length of types: String, BitArray, FsBitArray, FsLongitude, FsLatitude and array of bytes. Use a negative length for strings without 0 terminators.
WriteOnly	If true, Sets this Offset to only write data. Its value is never read from FSUIPC. You can change the setting with the WriteOnly property at any time.

◆ Offset() [5/8]

Offset	(	string	DataGroupName,
		int	Address )

inline

Creates a new Offset in the specified Group that will read from or write to the specified Offset.

Parameters

DataGroupName The name of the DataGroup to put this Offset into.

To process this Offset you must call Process() and pass the GroupName as a parameter.

Parameters

Address The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.

◆ Offset() [6/8]

Offset	(	string	DataGroupName,
		int	Address,
		bool	WriteOnly )

inline

Creates a new Offset in the specified Group that will read from or write to the specified Offset.

Parameters

DataGroupName The name of the DataGroup to put this Offset into.

To process this Offset you must call Process() and pass the GroupName as a parameter.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
WriteOnly	If true, Sets this Offset to only write data. Its value is never read from FSUIPC. You can change the setting with the WriteOnly property at any time.

◆ Offset() [7/8]

Offset	(	string	DataGroupName,
		int	Address,
		int	ArrayOrStringLength )

inline

Creates a new Offset that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

Parameters

DataGroupName The name of the DataGroup to put this Offset into.

To process this Offset you must call Process() and pass the GroupName as a parameter.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
ArrayOrStringLength	The number of bytes to read. Used to define the length of types: String, BitArray, FsBitArray, FsLongitude, FsLatitude and array of bytes. Use a negative length for strings without 0 terminators.

◆ Offset() [8/8]

Offset	(	string	DataGroupName,
		int	Address,
		int	ArrayOrStringLength,
		bool	WriteOnly )

inline

Creates a new Offset in the specified group that will read from or write the specified number of bytes to the specified Offset. Only used with data types of String, BitArray, FsBitArray, FsLongitude, FsLatitude and an array of bytes.

Parameters

DataGroupName The name of the DataGroup to put this Offset into.

To process this Offset you must call Process() and pass the GroupName as a parameter.

Parameters

Address	The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
ArrayOrStringLength	The number of bytes to read. Used to define the length of types: String, BitArray, FsBitArray, FsLongitude, FsLatitude and array of bytes. Use a negative length for strings without 0 terminators.
WriteOnly	If true, Sets this Offset to only write data. Its value is never read from FSUIPC. You can change the setting with the WriteOnly property at any time.

◆ ToString()

override string ToString ( )

inline

Return a string value containing information about this Offset.

Returns: A string containing the Offset Address, Data Type, and Length

Property Documentation

◆ Value

T Value

getset

The strongly-typed value of this offset.

Setting this property will cause the new value to be written to FSUIPC during the next Process() call.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Offset() [1/8]

◆ Offset() [2/8]

◆ Offset() [3/8]

◆ Offset() [4/8]

◆ Offset() [5/8]

◆ Offset() [6/8]

◆ Offset() [7/8]

◆ Offset() [8/8]

◆ ToString()

Property Documentation

◆ Value