ACOP.NET API
Public Member Functions | List of all members
Link Class Reference

Public Member Functions

String GetAddress ()
 Gets the link address for this link More...
 
object GetCallbackReference ()
 gets the assigned callback reference object More...
 
int GetDataTag ()
 gets the assigned integer data tag of the last data transfer More...
 
String GetDisplayDescription ()
 Gets the associated descpription More...
 
int GetDisplayId ()
 gets the assigned ACOP display id for this data link More...
 
double GetDisplayXMax ()
 Gets the associated X maximum value setting More...
 
double GetDisplayXMin ()
 Gets the associated X minimum value setting More...
 
String GetDisplayXUnits ()
 Gets the associated X axis units More...
 
double GetDisplayYMax ()
 Gets the associated Y maximum value setting More...
 
double GetDisplayYMin ()
 Gets the associated Y minimum value setting More...
 
String GetDisplayYUnits ()
 Gets the associated Y axis units More...
 
object GetInputDataObject ()
 get the input data object bound to the control More...
 
int GetLinkFlags ()
 gets any link flags assigned to the last transfered data More...
 
int GetLinkId ()
 gets the assigned transport link table id for this data link More...
 
string [] GetOutputChannelNames ()
 gets channel/array element names appropriate to the last transfered data More...
 
int GetOutputCompletionLength ()
 gets the completion length of the last data transfer More...
 
Int32 GetOutputDataAsInteger ()
 get the last transfered data as an integer More...
 
Int32 [] GetOutputDataAsIntegerArray ()
 get the last transfered data as an integer array More...
 
double GetOutputDataAsNumber ()
 get the last transfered data as a number More...
 
double [] GetOutputDataAsNumberArray ()
 get the last transfered data as a number array (doubles) More...
 
string GetOutputDataAsString ()
 get the last transfered data as a string More...
 
string GetOutputDataAsString (String delimiter)
 get the last transfered data as a string More...
 
string [] GetOutputDataAsStringArray ()
 get the last transfered data as a string array More...
 
object GetOutputDataObject ()
 get the output data object bound to the control More...
 
double [] GetOutputXAxis ()
 gets an array of numbers appropriate for an X (horizontal) axis in a display More...
 
double [] GetOutputYAxis ()
 gets an array of numbers appropriate for an Y (vertical) axis in a display More...
 
String GetProperty ()
 Gets the link property for this link More...
 
String GetProtocol ()
 Gets the link protocol for this link More...
 
int GetStatus ()
 gets the status code for the last data transfer More...
 
string GetStatusString ()
 gets the status string for the last data transfer More...
 
double GetTimeStamp ()
 gets the timestamp (UTC) of the last data transfer More...
 
Link [] GetTransportLinkTable ()
 gets a link table containing any link group members More...
 
Int32 [] GetTransportLinkTableDataAsIntegerArray ()
 gets an array of integer values (one per groupped link) in the last data transfer More...
 
double [] GetTransportLinkTableDataAsNumberArray ()
 gets an array of numbers (one per groupped link) in the last data transfer More...
 
String [] GetTransportLinkTableDataAsStringArray ()
 gets an array of string values (one per groupped link) in the last data transfer More...
 

Member Function Documentation

◆ GetAddress()

String GetAddress ( )
inline

Gets the link address for this link

Returns
the link address for this link

Referenced by AcopUserComponent.Detach().

◆ GetCallbackReference()

object GetCallbackReference ( )
inline

gets the assigned callback reference object

Returns
the assigned callback reference object

◆ GetDataTag()

int GetDataTag ( )
inline

gets the assigned integer data tag of the last data transfer

Returns
the assigned integer data tag of the last data transfer

Referenced by AcopComponent.GetDataTag(), and AcopUserComponent.GetDataTag().

◆ GetDisplayDescription()

String GetDisplayDescription ( )
inline

Gets the associated descpription

Returns
the associated description

◆ GetDisplayId()

int GetDisplayId ( )
inline

gets the assigned ACOP display id for this data link

Returns
the assigned ACOP display id for this data link (-1 if not assigned)

Referenced by AcopUserComponent.Detach().

◆ GetDisplayXMax()

double GetDisplayXMax ( )
inline

Gets the associated X maximum value setting

Returns
the associated X maximum value setting

◆ GetDisplayXMin()

double GetDisplayXMin ( )
inline

Gets the associated X minimum value setting

Returns
the associated X minimum value setting

◆ GetDisplayXUnits()

String GetDisplayXUnits ( )
inline

Gets the associated X axis units

Returns
the associated X axis units

◆ GetDisplayYMax()

double GetDisplayYMax ( )
inline

Gets the associated Y maximum value setting

Returns
the associated Y maximum value setting

◆ GetDisplayYMin()

double GetDisplayYMin ( )
inline

Gets the associated Y minimum value setting

Returns
the associated Y minimum value setting

◆ GetDisplayYUnits()

String GetDisplayYUnits ( )
inline

Gets the associated Y axis units

Returns
the associated Y axis units

◆ GetInputDataObject()

object GetInputDataObject ( )
inline

get the input data object bound to the control

Returns
the input data object bound to the control

◆ GetLinkFlags()

int GetLinkFlags ( )
inline

gets any link flags assigned to the last transfered data

Returns
any link flags assigned to the last transfered data

◆ GetLinkId()

int GetLinkId ( )
inline

gets the assigned transport link table id for this data link

Returns
the assigned transport link table id for this data link (-1 if not assigned)

Referenced by AcopComponent.Attach(), and AcopUserComponent.Attach().

◆ GetOutputChannelNames()

string [] GetOutputChannelNames ( )
inline

gets channel/array element names appropriate to the last transfered data

Returns
channel/array element names appropriate to the last transfered data

Referenced by AcopComponent.GetLinkOutputChannelNames(), and AcopUserComponent.GetLinkOutputChannelNames().

◆ GetOutputCompletionLength()

int GetOutputCompletionLength ( )
inline

gets the completion length of the last data transfer

Returns
the completion length of the last data transfer

Referenced by AcopComponent.GetOutputCompletionLength(), and AcopUserComponent.GetOutputCompletionLength().

◆ GetOutputDataAsInteger()

Int32 GetOutputDataAsInteger ( )
inline

get the last transfered data as an integer

Returns
the last transfered data as an integer

Referenced by AcopComponent.GetOutputDataAsInteger(), and Link.GetTransportLinkTableDataAsIntegerArray().

◆ GetOutputDataAsIntegerArray()

Int32 [] GetOutputDataAsIntegerArray ( )
inline

get the last transfered data as an integer array

Returns
the last transfered data as an integer array

◆ GetOutputDataAsNumber()

double GetOutputDataAsNumber ( )
inline

get the last transfered data as a number

Returns
the last transfered data as a number

Referenced by Link.GetTransportLinkTableDataAsNumberArray().

◆ GetOutputDataAsNumberArray()

double [] GetOutputDataAsNumberArray ( )
inline

get the last transfered data as a number array (doubles)

Returns
the last transfered data as a number array

◆ GetOutputDataAsString() [1/2]

string GetOutputDataAsString ( )
inline

get the last transfered data as a string

Returns
the last transfered data as a string

Referenced by AcopComponent.GetOutputDataAsString(), AcopComponent.GetOutputDataAsStringArray(), and Link.GetTransportLinkTableDataAsStringArray().

◆ GetOutputDataAsString() [2/2]

string GetOutputDataAsString ( String  delimiter)
inline

get the last transfered data as a string

Parameters
delimiterthe string separater for use in the string representation of a compound data type
Returns
the last transfered data as a string

◆ GetOutputDataAsStringArray()

string [] GetOutputDataAsStringArray ( )
inline

get the last transfered data as a string array

Returns
the last transfered data as a string array

◆ GetOutputDataObject()

object GetOutputDataObject ( )
inline

get the output data object bound to the control

Returns
the output data object bound to the control

Referenced by AcopComponent.GetLinkOutput(), AcopUserComponent.GetLinkOutput(), and AcopUserComponent.SingleUpdate().

◆ GetOutputXAxis()

double [] GetOutputXAxis ( )
inline

gets an array of numbers appropriate for an X (horizontal) axis in a display

Returns
an array of numbers appropriate for an X (horizontal) axis in a display

Referenced by AcopComponent.GetLinkOutputXAxis(), and AcopUserComponent.GetLinkOutputXAxis().

◆ GetOutputYAxis()

double [] GetOutputYAxis ( )
inline

gets an array of numbers appropriate for an Y (vertical) axis in a display

Returns
an array of numbers appropriate for an Y (vertical) axis in a display

Referenced by AcopComponent.GetLinkOutputYAxis(), and AcopUserComponent.GetLinkOutputYAxis().

◆ GetProperty()

String GetProperty ( )
inline

Gets the link property for this link

Returns
the link property for this link

Referenced by AcopUserComponent.Detach().

◆ GetProtocol()

String GetProtocol ( )
inline

Gets the link protocol for this link

Returns
the link protocol for this link

◆ GetStatus()

int GetStatus ( )
inline

gets the status code for the last data transfer

Returns
the status code for the last data transfer

Referenced by AcopComponent.GetStatus(), AcopUserComponent.GetStatus(), and AcopUserComponent.SingleUpdate().

◆ GetStatusString()

string GetStatusString ( )
inline

gets the status string for the last data transfer

Returns
the status string for the last data transfer

Referenced by AcopComponent.GetStatusString(), and AcopUserComponent.GetStatusString().

◆ GetTimeStamp()

double GetTimeStamp ( )
inline

gets the timestamp (UTC) of the last data transfer

Returns
the timestamp (UTC) of the last data transfer

Referenced by AcopComponent.GetTimeStamp(), and AcopUserComponent.GetTimeStamp().

◆ GetTransportLinkTable()

Link [] GetTransportLinkTable ( )
inline

gets a link table containing any link group members

Returns
a link table containing any link group members

Referenced by Link.GetTransportLinkTableDataAsIntegerArray(), Link.GetTransportLinkTableDataAsNumberArray(), and Link.GetTransportLinkTableDataAsStringArray().

◆ GetTransportLinkTableDataAsIntegerArray()

Int32 [] GetTransportLinkTableDataAsIntegerArray ( )
inline

gets an array of integer values (one per groupped link) in the last data transfer

Returns
an array of integer values (one per groupped link) in the last data transfer

References Link.GetOutputDataAsInteger(), and Link.GetTransportLinkTable().

◆ GetTransportLinkTableDataAsNumberArray()

double [] GetTransportLinkTableDataAsNumberArray ( )
inline

gets an array of numbers (one per groupped link) in the last data transfer

Returns
an array of numbers (one per groupped link) in the last data transfer

References Link.GetOutputDataAsNumber(), and Link.GetTransportLinkTable().

◆ GetTransportLinkTableDataAsStringArray()

String [] GetTransportLinkTableDataAsStringArray ( )
inline

gets an array of string values (one per groupped link) in the last data transfer

Returns
an array of string values (one per groupped link) in the last data transfer

References Link.GetOutputDataAsString(), and Link.GetTransportLinkTable().


The documentation for this class was generated from the following file:

Datenschutzerklaerung   -   Data Privacy Policy
Generated for ACOP.NET API by  doxygen 1.5.8