Represents an item of data that can be read from or written to an FSUIPC offset.
More...
Inherits FSUIPC::IOffset.
List of all members.
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 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 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 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 and an array of bytes.
|
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 () |
| Permenently 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.
|
Properties |
int | Address [get, set] |
| The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
|
DataType | Value [get, set] |
| The data from the FSUIPC Offset obtained from the last Process(). To write a value to the FSUIPC Offset, assign the new value to this property. It will be written to FSUIPC during 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.
|
Detailed Description
template<DataType>
class FSUIPC::Offset< DataType >
Represents an item of data that can be read from or written to an FSUIPC offset.
- Template Parameters:
-
DataType | 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
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
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.
- Parameters:
-
AfterNextProcess | If true, the Offset will not be disconnected until after you call Process(). If false the Offset is disconnected immediately. |
Offset |
( |
string |
DataGroupName, |
|
|
int |
Address |
|
) |
| |
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 |
( |
string |
DataGroupName, |
|
|
int |
Address, |
|
|
bool |
WriteOnly |
|
) |
| |
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 |
( |
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 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 and array of bytes. |
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 |
( |
int |
Address, |
|
|
bool |
WriteOnly |
|
) |
| |
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 |
( |
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 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 and array of bytes. |
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 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 and array of bytes. |
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. |
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 |
( |
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 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 and array of bytes. |
Permenently 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.
- Parameters:
-
ForNextProcessOnly | If true, the Offset is reconnected only for the next Process() call. After that it's disconnected again. If false, the Offset is reconnected until you call Disconnect(). |
Property Documentation
The FSUIPC offset address to read from or write to, as specified in the FSUIPC for Programmer's document.
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.
DataType Value [get, set] |
The data from the FSUIPC Offset obtained from the last Process(). To write a value to the FSUIPC Offset, assign the new value to this property. It will be written to FSUIPC during the next Process().
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.