ACOP.NET API
|
A smart bit-register display which can be attached to a control system element. More...
Public Member Functions | |
void | AddColorToList (String color) |
Adds a color (by string name) to the current color list More... | |
void | AddColorToList (Color color) |
Adds a color to the current color list More... | |
int | Attach () |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. Will attempt to discover and use the default output data object More... | |
int | Attach (object DataOut, object DataIn, int Flags, int interval, object reference) |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Attach (object DataOut, object DataIn, string Flags, int interval, object reference) |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Attach (object DataOut, int Offset, int Length, object DataIn, int Flags, int interval, object reference) |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Attach (object DataOut, int Offset, int Length, object DataIn, string Flags, int interval, object reference) |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Detach (String Protocol, String Address, String Property, object DataOut, object DataIn) |
Detaches the link specifed by the link parameters from the acop control. More... | |
int | Detach (String Address, String Property, object DataOut, object DataIn) |
Detaches the link specifed by the link parameters from the acop control. More... | |
int | Detach (String Protocol, String Address, String Property) |
Detaches the link specifed by the link parameters from the acop control. More... | |
int | Detach (String Address, String Property) |
Detaches the link specifed by the link parameters from the acop control. More... | |
int | Detach () |
Detaches all links attached to the acop control. More... | |
int | Execute () |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. Will attempt to discover and use the default output data object More... | |
int | Execute (object DataOut, object DataIn, int Flags, int timeout) |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Execute (object DataOut, object DataIn, string Flags, int timeout) |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Execute (object DataOut, int Offset, int Length, object DataIn, int Flags, int timeout) |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. More... | |
int | Execute (object DataOut, int Offset, int Length, object DataIn, string Flags, int timeout) |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. More... | |
Color [] | GetColorList () |
Gets the current color list as an array of colors More... | |
int | GetDataTag () |
Gets the last data tag (if any) associated with the output data. More... | |
int | GetFlags (String flags) |
Gets the integer flag representation of the input flags string More... | |
Link | GetLink () |
Returns the currently bound transport Link More... | |
object | GetLinkOutput () |
Returns the output data object bound to the default transport link More... | |
String [] | GetLinkOutputChannelNames () |
Returns a list of discovered channel names for the data bound to the default transport link (In case the transport link is bound to a multi-channel array). More... | |
double [] | GetLinkOutputXAxis () |
Returns the appropriate X-Axis for the data bound to the default transport link (for use in the chart) More... | |
double [] | GetLinkOutputYAxis () |
Returns the appropriate Y-Axis for the data bound to the default transport link (for use in the chart) More... | |
int | GetOutputCompletionLength () |
Gets the last delivered link output completion length. More... | |
object | GetOutputDataObject () |
Returns the output data object appropriate to the current link address More... | |
object | GetOutputDataObject (int instance) |
Returns the output data object appropriate to the current link address and given overload preference More... | |
int | GetStatus () |
Gets the current link status as an integer value More... | |
String | GetStatusString () |
Gets the current transport link status as a string More... | |
double | GetTimeStamp () |
Get the last link timestamp (as a UTC double). More... | |
Boolean | IsAttached () |
Gives the current link attached status based on the Link parameters More... | |
void | LinkUpdateInvoker (acopUpdate updater, object sender, Link lnk) |
An invoker helper for cases where InvokeRequired is needed More... | |
int | Reassign (String Address, String Property) |
Reassigns the current bound default link to the address parameters given. More... | |
int | ReassignList (String newGroupList, String newAddr, String newPrp) |
Reassigns the currently bound grouped links to those in the group list given More... | |
void | Reset () |
Closes all monitored links and resets display parameters to their default settings. If AutoAttachLink is 'true' then those links bound to the control will re-link. More... | |
void | Reset (Boolean allLinks) |
Closes all monitored links and resets display parameters to their default settings. If AutoAttachLink is 'true' then those links bound to the control will re-link. More... | |
void | setBitEditMode (Boolean mode) |
If true, the editing of the bits is activated More... | |
int | SingleUpdate () |
Applies a single link update to the acop user component if the component is not already in a monitoring state. More... | |
Static Public Member Functions | |
static double | getUtcNow () |
Returns the current UTC time (seconds since 1970) as a double (with fractional seconds). More... | |
Properties | |
object | AcopReferenceObject [get, set] |
An optional assigned object associated with this Acop control ... More... | |
Boolean | ApplyAcopLinkUpdateAfterAutoUpdate [get, set] |
Determines the firing order of a user-defined acopLinkUpdate delegate More... | |
ApplyEventSettingType | ApplyEventOrder [get, set] |
Determines the firing order of a user-defined acopApply delegate More... | |
UnitsLocation | ApplyLocation [get, set] |
the prefered location to apply units (default = description) More... | |
bool | AutoLinkAttach [get, set] |
if set to true, instructs ACOP to automatically monitor the data provided by LinkAddress and LinkProperty More... | |
int | AutoLinkCapacity [get, set] |
if non-zero, provides the requested data size to use when AutoLinkUpdate is set to true More... | |
bool | AutoLinkUpdate [get, set] |
if set to true, instructs ACOP to update this component's contents upon receipt of new link data (provided no user-defined event handle is in play) More... | |
Color | BitOffColor [get, set] |
The color if the bit has the value 0 More... | |
Color | BitOnColor [get, set] |
The color if the bit has the value 1 More... | |
int | BitSize [get, set] |
The width and height of the bits More... | |
Boolean | CloseLinkOnMinimized [get, set] |
If true the Link will be closed if the form is minimized More... | |
int | DefaultMonitorInterval [get, set] |
The default monitoring interval in msec More... | |
String [] | DescriptionList [get, set] |
The description of the individual bits More... | |
int | DisplayedFirstBit [get, set] |
Specifies the start bit More... | |
int | DisplayedLength [get, set] |
The number of bits to be displayed More... | |
String | ErrorValue [get, set] |
value to use when there are link errors More... | |
Boolean | IsEditable [get, set] |
If true allows the setting of individual bits via the context menu More... | |
String | LinkAddress [get, set] |
Identifies the transport link target. The target end point is given by the LinkAddress and the LinkProperty. More... | |
String | LinkContext [get, set] |
The design-time browseable link context (part of the link address) More... | |
String | LinkDevice [get, set] |
The design-time browseable/editable link device (part of the link address) More... | |
String | LinkFlags [get, set] |
An optional design-time browseable flags set which can be applied to the underlying link More... | |
String | LinkInputValue [get, set] |
optional value to use as input for automatic links More... | |
String | LinkList [get, set] |
A design-time list of targeted links. If there is more than one target then 'LinkGrouped' is automatically set to 'true' More... | |
String | LinkProperty [get, set] |
The design-time browseable/editable link property (suppliments the link address)" More... | |
String | LinkProtocol [get, set] |
The link control system protocol More... | |
String | LinkServer [get, set] |
The design-time browseable link server (part of the link address) More... | |
String | LinkSubSystem [get, set] |
The design-time browseable link subsystem More... | |
orientationEnum | Orientation [get, set] |
Sets the register orientation More... | |
long | RegisterValue [get, set] |
The register value More... | |
Boolean | ShowBitDescription [get, set] |
Show the description labels for each bit More... | |
Boolean | ShowBitNumbers [get, set] |
Show the bit numbers More... | |
String | ToolTipText [get, set] |
if non-empty then the string provided will be used as component's tool tip text; if 'none' then no tool tip text; else the associated link address More... | |
Events | |
acopApplySetting | acopApply |
Occurs when the control attempts to apply the setting shown to the link address More... | |
acopError | acopLinkError |
Occurs when the underlying monitored link enters an error state (via acopApply or acopLinkUpdate) More... | |
acopUpdate | acopLinkUpdate |
Occurs when the underlying monitored link has updated its data More... | |
acopResetSetting | acopReset |
Occurs when the control attempts to reset the setting shown to the link address More... | |
A smart bit-register display which can be attached to a control system element.
|
inlineinherited |
Adds a color (by string name) to the current color list
color | the color (as a string) to add the color list |
Referenced by AcopUserComponent.AddColorToList().
|
inlineinherited |
Adds a color to the current color list
color | the color to add to the color list |
References AcopUserComponent.AddColorToList().
|
inlineinherited |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields. Will attempt to discover and use the default output data object
References AcopUserComponent.DefaultMonitorInterval, AcopUserComponent.GetFlags(), and Link.GetLinkId().
Referenced by AcopUserComponent.Attach(), and AcopUserComponent.Reassign().
|
inlineinherited |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags |
interval | An update interval (or timeout) in milliseconds |
reference | Any reference which should be returned in the link's update event |
References Link.GetLinkId().
|
inlineinherited |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags |
interval | An update interval (or timeout) in milliseconds |
reference | Any reference which should be returned in the link's update event |
References AcopUserComponent.Attach(), and AcopUserComponent.GetFlags().
|
inlineinherited |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
Offset | A specific offset into the output data object (array) reference. Output data will begin filling at this offset. |
Length | The length of the output data object (array) which is to be filled in. |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags string (i.e. one of the values shown in the property grid) |
interval | An update interval (or timeout) in milliseconds |
reference | Any reference which should be returned in the link's update event |
References Link.GetLinkId().
|
inlineinherited |
Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
Offset | A specific offset into the output data object (array) reference. Output data will begin filling at this offset. |
Length | The length of the output data object (array) which is to be filled in. |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags string (i.e. one of the values shown in the property grid) |
interval | An update interval (or timeout) in milliseconds |
reference | Any reference which should be returned in the link's update event |
References AcopUserComponent.Attach(), and AcopUserComponent.GetFlags().
|
inlineinherited |
Detaches the link specifed by the link parameters from the acop control.
Protocol | Control system protocol |
Address | The link address |
Property | The link property |
DataOut | The output data object |
DataIn | The input data object |
References AcopUserComponent.AutoLinkAttach, AcopChart.AutoTrendUpdate, AcopChart.ClearScreen(), Link.GetAddress(), Link.GetDisplayId(), Link.GetProperty(), AcopUserComponent.LinkAddress, and AcopUserComponent.LinkProperty.
|
inlineinherited |
Detaches the link specifed by the link parameters from the acop control.
Address | The link address |
Property | The link property |
DataOut | The output data object |
DataIn | The input data object |
References AcopUserComponent.Detach().
|
inlineinherited |
Detaches the link specifed by the link parameters from the acop control.
Protocol | Control system protocol |
Address | The link address |
Property | The link property |
References AcopUserComponent.Detach().
|
inlineinherited |
Detaches the link specifed by the link parameters from the acop control.
Address | The link address |
Property | The link property |
References AcopUserComponent.Detach().
|
inlineinherited |
Detaches all links attached to the acop control.
Referenced by AcopUserComponent.Detach().
|
inlineinherited |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields. Will attempt to discover and use the default output data object
References AcopUserComponent.DefaultMonitorInterval, and AcopUserComponent.GetFlags().
Referenced by AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().
|
inlineinherited |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags |
timeout | timeout in milliseconds |
|
inlineinherited |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags string (i.e. one of the values shown in the property grid) |
timeout | timeout in milliseconds |
References AcopUserComponent.Execute(), and AcopUserComponent.GetFlags().
|
inlineinherited |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
Offset | A specific offset into the output data object (array) reference. Output data will begin filling at this offset. |
Length | The length of the output data object (array) which is to be filled in. |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags |
timeout | timeout in milliseconds |
|
inlineinherited |
Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.
DataOut | A reference to the output data object which is to be filled |
Offset | A specific offset into the output data object (array) reference. Output data will begin filling at this offset. |
Length | The length of the output data object (array) which is to be filled in. |
DataIn | A reference to an input data object to be sent to the link address |
Flags | Any optional link flags string (i.e. one of the values shown in the property grid) |
timeout | timeout in milliseconds |
References AcopUserComponent.Execute(), and AcopUserComponent.GetFlags().
|
inlineinherited |
Gets the current color list as an array of colors
|
inlineinherited |
Gets the last data tag (if any) associated with the output data.
References Link.GetDataTag().
|
inlineinherited |
Gets the integer flag representation of the input flags string
flags |
Referenced by AcopUserComponent.Attach(), AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().
|
inlineinherited |
|
inlineinherited |
Returns the output data object bound to the default transport link
References Link.GetOutputDataObject().
|
inlineinherited |
Returns a list of discovered channel names for the data bound to the default transport link (In case the transport link is bound to a multi-channel array).
References Link.GetOutputChannelNames().
|
inlineinherited |
Returns the appropriate X-Axis for the data bound to the default transport link (for use in the chart)
References Link.GetOutputXAxis().
|
inlineinherited |
Returns the appropriate Y-Axis for the data bound to the default transport link (for use in the chart)
References Link.GetOutputYAxis().
|
inlineinherited |
Gets the last delivered link output completion length.
References Link.GetOutputCompletionLength().
|
inlineinherited |
Returns the output data object appropriate to the current link address
|
inlineinherited |
Returns the output data object appropriate to the current link address and given overload preference
instance | the desired overload |
|
inlineinherited |
Gets the current link status as an integer value
References Link.GetStatus().
|
inlineinherited |
Gets the current transport link status as a string
References Link.GetStatusString().
|
inlineinherited |
Get the last link timestamp (as a UTC double).
References Link.GetTimeStamp().
|
inlinestaticinherited |
Returns the current UTC time (seconds since 1970) as a double (with fractional seconds).
Referenced by AcopChart.GetTrendPoints(), and AcopTable.GetTrendPoints().
|
inlineinherited |
Gives the current link attached status based on the Link parameters
|
inlineinherited |
An invoker helper for cases where InvokeRequired is needed
updater | is the delegate to invoke |
sender | is the sender object |
lnk | is the Link object |
|
inlineinherited |
Reassigns the current bound default link to the address parameters given.
Address | the desired new target link address |
Property | the desired new target link property |
References AcopUserComponent.Attach(), AcopChart.ClearScreen(), AcopChart.ForegroundColor, AcopChart.GetPlotMode(), TraceChart.IsTrace, AcopChart.PlotMode, AcopUserComponent.ReassignList(), AcopTable.ResetInput(), AcopTable.ShowInputColumn, and AcopChart.TraceSettings.
|
inlineinherited |
Reassigns the currently bound grouped links to those in the group list given
The new group list must have the same number of links as the list it is to replace, else an "Invalid Length" exception is thrown.
newGroupList | is the ';' separated list of grouped link addresses |
newAddr | is the new assigned LinkAddress |
newPrp | is the new assigned LinkProperty |
References AcopUserComponent.LinkAddress, AcopUserComponent.LinkProperty, and AcopTable.ResetInput().
Referenced by AcopUserComponent.Reassign().
|
inlineinherited |
Closes all monitored links and resets display parameters to their default settings. If AutoAttachLink is 'true' then those links bound to the control will re-link.
Referenced by AcopUtils.ResetAcopLinks().
|
inlineinherited |
Closes all monitored links and resets display parameters to their default settings. If AutoAttachLink is 'true' then those links bound to the control will re-link.
allLinks | if 'true' then all bound links are examined. |
References AcopChart.ClearScreen(), AcopChart.ForegroundColor, AcopChart.GetPlotMode(), TraceChart.IsTrace, AcopChart.PlotMode, and AcopChart.TraceSettings.
|
inline |
If true, the editing of the bits is activated
mode |
|
inlineinherited |
Applies a single link update to the acop user component if the component is not already in a monitoring state.
References AcopUserComponent.acopLinkError, AcopUserComponent.acopLinkUpdate, AcopUserComponent.DefaultMonitorInterval, AcopUserComponent.Execute(), AcopUserComponent.GetFlags(), Link.GetOutputDataObject(), and Link.GetStatus().
|
getsetinherited |
An optional assigned object associated with this Acop control ...
|
getsetinherited |
Determines the firing order of a user-defined acopLinkUpdate delegate
|
getsetinherited |
Determines the firing order of a user-defined acopApply delegate
|
getsetinherited |
the prefered location to apply units (default = description)
|
getsetinherited |
if set to true, instructs ACOP to automatically monitor the data provided by LinkAddress and LinkProperty
Referenced by AcopUserComponent.Detach().
|
getsetinherited |
if non-zero, provides the requested data size to use when AutoLinkUpdate is set to true
|
getsetinherited |
if set to true, instructs ACOP to update this component's contents upon receipt of new link data (provided no user-defined event handle is in play)
|
getset |
The color if the bit has the value 0
|
getset |
The color if the bit has the value 1
|
getset |
The width and height of the bits
|
getsetinherited |
If true the Link will be closed if the form is minimized
|
getsetinherited |
The default monitoring interval in msec
Referenced by AcopUserComponent.Attach(), AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().
|
getset |
The description of the individual bits
|
getset |
Specifies the start bit
|
getset |
The number of bits to be displayed
|
getsetinherited |
value to use when there are link errors
|
getset |
If true allows the setting of individual bits via the context menu
|
getsetinherited |
Identifies the transport link target. The target end point is given by the LinkAddress and the LinkProperty.
Referenced by AcopSlider.applySliderSetting(), AcopUserComponent.Detach(), and AcopUserComponent.ReassignList().
|
getsetinherited |
The design-time browseable link context (part of the link address)
|
getsetinherited |
The design-time browseable/editable link device (part of the link address)
|
getsetinherited |
An optional design-time browseable flags set which can be applied to the underlying link
|
getsetinherited |
optional value to use as input for automatic links
|
getsetinherited |
A design-time list of targeted links. If there is more than one target then 'LinkGrouped' is automatically set to 'true'
|
getsetinherited |
The design-time browseable/editable link property (suppliments the link address)"
Referenced by AcopSlider.applySliderSetting(), AcopUserComponent.Detach(), and AcopUserComponent.ReassignList().
|
getsetinherited |
The link control system protocol
Referenced by AcopSlider.applySliderSetting().
|
getsetinherited |
The design-time browseable link server (part of the link address)
|
getsetinherited |
The design-time browseable link subsystem
|
getset |
Sets the register orientation
|
getset |
The register value
|
getset |
Show the description labels for each bit
|
getset |
Show the bit numbers
|
getsetinherited |
if non-empty then the string provided will be used as component's tool tip text; if 'none' then no tool tip text; else the associated link address
|
inherited |
Occurs when the control attempts to apply the setting shown to the link address
|
inherited |
Occurs when the underlying monitored link enters an error state (via acopApply or acopLinkUpdate)
Referenced by AcopUserComponent.SingleUpdate().
|
inherited |
Occurs when the underlying monitored link has updated its data
Referenced by AcopUserComponent.SingleUpdate().
|
inherited |
Occurs when the control attempts to reset the setting shown to the link address