ACOP.NET API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | Events | List of all members
AcopMagnet Class Reference

A smart magnet display shape, which can be associated with a control system element. More...

Inheritance diagram for AcopMagnet:
AcopShape AcopUserComponent

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 SetControlPanel (String value)
 Supply an external control process to launch. The supplied string should refer to an executable application in the same startup directory as the primary application. The application will be started with the primary link address as a command line argument. More...
 
void SetControlPanel (Form value)
 Supply an external window form for control. The window form will contain the primary link address as both the form 'tag' and as caption text. More...
 
void SetHotSpot (Point point)
 Establish a hot spot at the coordinates given. (Overwrites any existing hot spot). More...
 
void SetHotSpot (Point point, int radius)
 Establish a hot spot at the coordinates given. (Overwrites any existing hot spot). 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...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. 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...
 
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...
 
Int32 BlinkIntensity [get, set]
 set the blink intensity for the shape component (up to 100% lighter or -100% darker) More...
 
Int32 BlinkInterval [get, set]
 set the blink interval (msec) for the shape component More...
 
MagnetBlinkMode BlinkMagnet [get, set]
 set the blink mode for the valve component More...
 
Int32 BlinkSlot [get, set]
 set the blink slot for the shape component (0 up to the number of slots) More...
 
Color BorderColor [get, set]
 border color of rectangle region More...
 
Int32 BorderWidth [get, set]
 border width of rectangle region More...
 
Boolean CloseLinkOnMinimized [get, set]
 If true the Link will be closed if the form is minimized More...
 
String ControlPanelApplication [get, set]
 provide the name of an application to use as a control panel. More...
 
Int32 CornerRadius [get, set]
 corner radius of rectangle region More...
 
int DefaultMonitorInterval [get, set]
 The default monitoring interval in msec More...
 
int DipoleGap [get, set]
 establishes the basic shape of the triangle More...
 
String DisplayInformation [get, set]
 if non-empty then the displayed value upon update will be the value given More...
 
Boolean DisplayText [get, set]
 true: display input text/readback value on shape More...
 
new DisplayValueChoice DisplayValue [get, set]
 set/get the display text category (displayed upon update) More...
 
String ErrorValue [get, set]
 value to use when there are link errors More...
 
GradientEnum Gradient [get, set]
 color gradient for filled region More...
 
GradientStyleEnum GradientStyle [get, set]
 color gradient style for filled region 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...
 
Boolean LinkGrouped [get, set]
 gets/sets whether all associated links have a grouped event More...
 
Boolean LinkInformationAsToolTip [get, set]
 if true, then the link information associated with the shape will be displayed as tooltip information. 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...
 
Color MagnetColor [get, set]
 background color of magnet when its state (on or off) is unknown More...
 
Color MagnetOffColor [get, set]
 color of magnet when it is in an off state More...
 
Color MagnetOnColor [get, set]
 color of magnet when it is in an on state More...
 
MagnetType MagnetShape [get, set]
 specfies the basic magnet shape. More...
 
ComponentState MagnetState [get, set]
 establishes the magnet state ('on' or 'off') More...
 
Int32 NumberBlinkSlots [get, set]
 set the number of blink slots for the shape component (at least 2) More...
 
DipoleOrientation Orientation [get, set]
 establishes the magnet orientation More...
 
Color OutOfSyncColor [get, set]
 background color of magnet when its readback and setpoint are not in sync More...
 
int Precision [get, set]
 precision to use for floating point numbers (0 => general format) More...
 
String ReadBackProperty [get, set]
 The property associated with the magnet read-back value More...
 
Boolean RotateText [get, set]
 true: apply rotation angle to displayed text More...
 
Int32 RotationAngle [get, set]
 rotation angle of rectangle region More...
 
Color TextColor [get, set]
 color of display text in rectangle region More...
 
Font TextFont [get, set]
 font of display text in rectangle region More...
 
String ThresholdOff [get, set]
 establishes the magnet 'off' threshold criterion (value .LE. threshold -> magnet is off) More...
 
String ThresholdOn [get, set]
 establishes the magnet 'on' threshold criterion (value .GE. threshold -> dipole is on) 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...
 
String Units [get, set]
 the value units More...
 
double ValueOffset [get, set]
 if target value is a number type, then this offset will be applied following data acquisition More...
 
double ValueScale [get, set]
 if target value is a number type, then this offset will be applied following data acquisition More...
 

Events

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...
 

Detailed Description

A smart magnet display shape, which can be associated with a control system element.

Member Function Documentation

◆ AddColorToList() [1/2]

void AddColorToList ( String  color)
inlineinherited

Adds a color (by string name) to the current color list

Parameters
colorthe color (as a string) to add the color list

Referenced by AcopUserComponent.AddColorToList().

◆ AddColorToList() [2/2]

void AddColorToList ( Color  color)
inlineinherited

Adds a color to the current color list

Parameters
colorthe color to add to the color list

References AcopUserComponent.AddColorToList().

◆ Attach() [1/5]

int Attach ( )
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

Returns
A positive link ID or -1 if the link cannot be established.

References AcopUserComponent.DefaultMonitorInterval, AcopUserComponent.GetFlags(), and Link.GetLinkId().

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

◆ Attach() [2/5]

int Attach ( object  DataOut,
object  DataIn,
int  Flags,
int  interval,
object  reference 
)
inlineinherited

Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags
intervalAn update interval (or timeout) in milliseconds
referenceAny reference which should be returned in the link's update event
Returns
A positive link ID or -1 if the link cannot be established.

References Link.GetLinkId().

◆ Attach() [3/5]

int Attach ( object  DataOut,
object  DataIn,
string  Flags,
int  interval,
object  reference 
)
inlineinherited

Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags
intervalAn update interval (or timeout) in milliseconds
referenceAny reference which should be returned in the link's update event
Returns
A positive link ID or -1 if the link cannot be established.

References AcopUserComponent.Attach(), and AcopUserComponent.GetFlags().

◆ Attach() [4/5]

int Attach ( object  DataOut,
int  Offset,
int  Length,
object  DataIn,
int  Flags,
int  interval,
object  reference 
)
inlineinherited

Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
OffsetA specific offset into the output data object (array) reference. Output data will begin filling at this offset.
LengthThe length of the output data object (array) which is to be filled in.
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags string (i.e. one of the values shown in the property grid)
intervalAn update interval (or timeout) in milliseconds
referenceAny reference which should be returned in the link's update event
Returns
A positive link ID or -1 if the link cannot be established.

References Link.GetLinkId().

◆ Attach() [5/5]

int Attach ( object  DataOut,
int  Offset,
int  Length,
object  DataIn,
string  Flags,
int  interval,
object  reference 
)
inlineinherited

Attaches a transport link to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
OffsetA specific offset into the output data object (array) reference. Output data will begin filling at this offset.
LengthThe length of the output data object (array) which is to be filled in.
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags string (i.e. one of the values shown in the property grid)
intervalAn update interval (or timeout) in milliseconds
referenceAny reference which should be returned in the link's update event
Returns
A positive link ID or -1 if the link cannot be established.

References AcopUserComponent.Attach(), and AcopUserComponent.GetFlags().

◆ Detach() [1/5]

int Detach ( String  Protocol,
String  Address,
String  Property,
object  DataOut,
object  DataIn 
)
inlineinherited

Detaches the link specifed by the link parameters from the acop control.

Parameters
ProtocolControl system protocol
AddressThe link address
PropertyThe link property
DataOutThe output data object
DataInThe input data object
Returns
0 upon success or -1 on error

References AcopUserComponent.AutoLinkAttach, AcopChart.AutoTrendUpdate, AcopChart.ClearScreen(), Link.GetAddress(), Link.GetDisplayId(), Link.GetProperty(), AcopUserComponent.LinkAddress, and AcopUserComponent.LinkProperty.

◆ Detach() [2/5]

int Detach ( String  Address,
String  Property,
object  DataOut,
object  DataIn 
)
inlineinherited

Detaches the link specifed by the link parameters from the acop control.

Parameters
AddressThe link address
PropertyThe link property
DataOutThe output data object
DataInThe input data object
Returns
0 upon success or -1 on error

References AcopUserComponent.Detach().

◆ Detach() [3/5]

int Detach ( String  Protocol,
String  Address,
String  Property 
)
inlineinherited

Detaches the link specifed by the link parameters from the acop control.

Parameters
ProtocolControl system protocol
AddressThe link address
PropertyThe link property
Returns
0 upon success or -1 on error

References AcopUserComponent.Detach().

◆ Detach() [4/5]

int Detach ( String  Address,
String  Property 
)
inlineinherited

Detaches the link specifed by the link parameters from the acop control.

Parameters
AddressThe link address
PropertyThe link property
Returns
0 upon success or -1 on error

References AcopUserComponent.Detach().

◆ Detach() [5/5]

int Detach ( )
inlineinherited

Detaches all links attached to the acop control.

Returns
0 upon success or -1 on error

Referenced by AcopUserComponent.Detach().

◆ Dispose()

override void Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

References AcopComponent.Detach().

◆ Execute() [1/5]

int Execute ( )
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

Returns
0 upon success or -1 if there is a link error.

References AcopUserComponent.DefaultMonitorInterval, and AcopUserComponent.GetFlags().

Referenced by AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().

◆ Execute() [2/5]

int Execute ( object  DataOut,
object  DataIn,
int  Flags,
int  timeout 
)
inlineinherited

Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags
timeouttimeout in milliseconds
Returns
0 upon success or -1 if there is a link error.

◆ Execute() [3/5]

int Execute ( object  DataOut,
object  DataIn,
string  Flags,
int  timeout 
)
inlineinherited

Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags string (i.e. one of the values shown in the property grid)
timeouttimeout in milliseconds
Returns
0 upon success or -1 if there is a link error.

References AcopUserComponent.Execute(), and AcopUserComponent.GetFlags().

◆ Execute() [4/5]

int Execute ( object  DataOut,
int  Offset,
int  Length,
object  DataIn,
int  Flags,
int  timeout 
)
inlineinherited

Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
OffsetA specific offset into the output data object (array) reference. Output data will begin filling at this offset.
LengthThe length of the output data object (array) which is to be filled in.
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags
timeouttimeout in milliseconds
Returns
0 upon success or -1 if there is a link error.

◆ Execute() [5/5]

int Execute ( object  DataOut,
int  Offset,
int  Length,
object  DataIn,
string  Flags,
int  timeout 
)
inlineinherited

Executes a single synchronous transport call to the link target contained in the LinkAddress and LinkProperty fields.

Parameters
DataOutA reference to the output data object which is to be filled
OffsetA specific offset into the output data object (array) reference. Output data will begin filling at this offset.
LengthThe length of the output data object (array) which is to be filled in.
DataInA reference to an input data object to be sent to the link address
FlagsAny optional link flags string (i.e. one of the values shown in the property grid)
timeouttimeout in milliseconds
Returns
0 upon success or -1 if there is a link error.

References AcopUserComponent.Execute(), and AcopUserComponent.GetFlags().

◆ GetColorList()

Color [] GetColorList ( )
inlineinherited

Gets the current color list as an array of colors

Returns
the current color list as an array of colors

◆ GetDataTag()

int GetDataTag ( )
inlineinherited

Gets the last data tag (if any) associated with the output data.

Returns
The last data tag (if any) associated with the output data.

References Link.GetDataTag().

◆ GetFlags()

int GetFlags ( String  flags)
inlineinherited

Gets the integer flag representation of the input flags string

Parameters
flags
Returns
the integer flag representation of the input flags string

Referenced by AcopUserComponent.Attach(), AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().

◆ GetLink()

Link GetLink ( )
inlineinherited

Returns the currently bound transport Link

Returns
the currently bound transport Link or null if no Link is attached

◆ GetLinkOutput()

object GetLinkOutput ( )
inlineinherited

Returns the output data object bound to the default transport link

Returns
the output data object bound to the default transport link

References Link.GetOutputDataObject().

◆ GetLinkOutputChannelNames()

String [] GetLinkOutputChannelNames ( )
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).

Returns
a list of discovered channel names for the data bound to the default transport link

References Link.GetOutputChannelNames().

◆ GetLinkOutputXAxis()

double [] GetLinkOutputXAxis ( )
inlineinherited

Returns the appropriate X-Axis for the data bound to the default transport link (for use in the chart)

Returns
the appropriate X-Axis for the data bound to the default transport link

References Link.GetOutputXAxis().

◆ GetLinkOutputYAxis()

double [] GetLinkOutputYAxis ( )
inlineinherited

Returns the appropriate Y-Axis for the data bound to the default transport link (for use in the chart)

Returns
the appropriate Y-Axis for the data bound to the default transport link

References Link.GetOutputYAxis().

◆ GetOutputCompletionLength()

int GetOutputCompletionLength ( )
inlineinherited

Gets the last delivered link output completion length.

Returns
The last delivered link output completion length.

References Link.GetOutputCompletionLength().

◆ GetOutputDataObject() [1/2]

object GetOutputDataObject ( )
inlineinherited

Returns the output data object appropriate to the current link address

Returns
the output data object appropriate to the current link address

◆ GetOutputDataObject() [2/2]

object GetOutputDataObject ( int  instance)
inlineinherited

Returns the output data object appropriate to the current link address and given overload preference

Parameters
instancethe desired overload
Returns
the output data object appropriate to the current link address

◆ GetStatus()

int GetStatus ( )
inlineinherited

Gets the current link status as an integer value

Returns
The current link status as an integer value

References Link.GetStatus().

◆ GetStatusString()

String GetStatusString ( )
inlineinherited

Gets the current transport link status as a string

Returns
The current transport link status as a string

References Link.GetStatusString().

◆ GetTimeStamp()

double GetTimeStamp ( )
inlineinherited

Get the last link timestamp (as a UTC double).

Returns
The last link timestamp (as a UTC double).

References Link.GetTimeStamp().

◆ getUtcNow()

static double getUtcNow ( )
inlinestaticinherited

Returns the current UTC time (seconds since 1970) as a double (with fractional seconds).

Returns
the current UTC time (seconds since 1970) as a double (with fractional seconds)

Referenced by AcopChart.GetTrendPoints(), and AcopTable.GetTrendPoints().

◆ IsAttached()

Boolean IsAttached ( )
inlineinherited

Gives the current link attached status based on the Link parameters

Returns
'true' if the component is attached to its link parameters

◆ LinkUpdateInvoker()

void LinkUpdateInvoker ( acopUpdate  updater,
object  sender,
Link  lnk 
)
inlineinherited

An invoker helper for cases where InvokeRequired is needed

Parameters
updateris the delegate to invoke
senderis the sender object
lnkis the Link object

◆ Reassign()

int Reassign ( String  Address,
String  Property 
)
inlineinherited

Reassigns the current bound default link to the address parameters given.

Parameters
Addressthe desired new target link address
Propertythe desired new target link property
Returns
a positive link handle to the new link upon success, otherwise -1.

References AcopUserComponent.Attach(), AcopChart.ClearScreen(), AcopChart.ForegroundColor, AcopChart.GetPlotMode(), TraceChart.IsTrace, AcopChart.PlotMode, AcopUserComponent.ReassignList(), AcopTable.ResetInput(), AcopTable.ShowInputColumn, and AcopChart.TraceSettings.

◆ ReassignList()

int ReassignList ( String  newGroupList,
String  newAddr,
String  newPrp 
)
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.

Parameters
newGroupListis the ';' separated list of grouped link addresses
newAddris the new assigned LinkAddress
newPrpis the new assigned LinkProperty
Returns
0 upon success

References AcopUserComponent.LinkAddress, AcopUserComponent.LinkProperty, and AcopTable.ResetInput().

Referenced by AcopUserComponent.Reassign().

◆ Reset() [1/2]

void Reset ( )
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().

◆ Reset() [2/2]

void Reset ( Boolean  allLinks)
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.

Parameters
allLinksif 'true' then all bound links are examined.

References AcopChart.ClearScreen(), AcopChart.ForegroundColor, AcopChart.GetPlotMode(), TraceChart.IsTrace, AcopChart.PlotMode, and AcopChart.TraceSettings.

◆ SetControlPanel() [1/2]

void SetControlPanel ( String  value)
inlineinherited

Supply an external control process to launch. The supplied string should refer to an executable application in the same startup directory as the primary application. The application will be started with the primary link address as a command line argument.

Parameters
valueThe name of the application process to launch.

◆ SetControlPanel() [2/2]

void SetControlPanel ( Form  value)
inlineinherited

Supply an external window form for control. The window form will contain the primary link address as both the form 'tag' and as caption text.

Parameters
valueThe form instance to be displayed.

◆ SetHotSpot() [1/2]

void SetHotSpot ( Point  point)
inlineinherited

Establish a hot spot at the coordinates given. (Overwrites any existing hot spot).

Parameters
pointAn X/Y point providing the center of the spot

◆ SetHotSpot() [2/2]

void SetHotSpot ( Point  point,
int  radius 
)
inlineinherited

Establish a hot spot at the coordinates given. (Overwrites any existing hot spot).

Parameters
pointAn X/Y point providing the center of the spot
radiusthe extent of the hot spot.

◆ SingleUpdate()

int SingleUpdate ( )
inlineinherited

Applies a single link update to the acop user component if the component is not already in a monitoring state.

Returns
0 upon success or -1 if there is a link error.

References AcopUserComponent.acopLinkError, AcopUserComponent.acopLinkUpdate, AcopUserComponent.DefaultMonitorInterval, AcopUserComponent.Execute(), AcopUserComponent.GetFlags(), Link.GetOutputDataObject(), and Link.GetStatus().

Property Documentation

◆ AcopReferenceObject

object AcopReferenceObject
getsetinherited

An optional assigned object associated with this Acop control ...

◆ ApplyAcopLinkUpdateAfterAutoUpdate

Boolean ApplyAcopLinkUpdateAfterAutoUpdate
getsetinherited

Determines the firing order of a user-defined acopLinkUpdate delegate

◆ ApplyLocation

UnitsLocation ApplyLocation
getsetinherited

the prefered location to apply units (default = description)

◆ AutoLinkAttach

bool AutoLinkAttach
getsetinherited

if set to true, instructs ACOP to automatically monitor the data provided by LinkAddress and LinkProperty

Referenced by AcopUserComponent.Detach().

◆ AutoLinkCapacity

int AutoLinkCapacity
getsetinherited

if non-zero, provides the requested data size to use when AutoLinkUpdate is set to true

◆ AutoLinkUpdate

bool AutoLinkUpdate
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)

◆ BlinkIntensity

Int32 BlinkIntensity
getsetinherited

set the blink intensity for the shape component (up to 100% lighter or -100% darker)

◆ BlinkInterval

Int32 BlinkInterval
getsetinherited

set the blink interval (msec) for the shape component

◆ BlinkMagnet

MagnetBlinkMode BlinkMagnet
getset

set the blink mode for the valve component

◆ BlinkSlot

Int32 BlinkSlot
getsetinherited

set the blink slot for the shape component (0 up to the number of slots)

◆ BorderColor

Color BorderColor
getsetinherited

border color of rectangle region

◆ BorderWidth

Int32 BorderWidth
getsetinherited

border width of rectangle region

◆ CloseLinkOnMinimized

Boolean CloseLinkOnMinimized
getsetinherited

If true the Link will be closed if the form is minimized

◆ ControlPanelApplication

String ControlPanelApplication
getsetinherited

provide the name of an application to use as a control panel.

◆ CornerRadius

Int32 CornerRadius
getsetinherited

corner radius of rectangle region

◆ DefaultMonitorInterval

int DefaultMonitorInterval
getsetinherited

The default monitoring interval in msec

Referenced by AcopUserComponent.Attach(), AcopUserComponent.Execute(), and AcopUserComponent.SingleUpdate().

◆ DipoleGap

int DipoleGap
getset

establishes the basic shape of the triangle

◆ DisplayInformation

String DisplayInformation
getsetinherited

if non-empty then the displayed value upon update will be the value given

◆ DisplayText

Boolean DisplayText
getsetinherited

true: display input text/readback value on shape

◆ DisplayValue

new DisplayValueChoice DisplayValue
getset

set/get the display text category (displayed upon update)

◆ ErrorValue

String ErrorValue
getsetinherited

value to use when there are link errors

◆ Gradient

GradientEnum Gradient
getsetinherited

color gradient for filled region

◆ GradientStyle

GradientStyleEnum GradientStyle
getsetinherited

color gradient style for filled region

◆ LinkAddress

String LinkAddress
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().

◆ LinkContext

String LinkContext
getsetinherited

The design-time browseable link context (part of the link address)

◆ LinkDevice

String LinkDevice
getsetinherited

The design-time browseable/editable link device (part of the link address)

◆ LinkFlags

String LinkFlags
getsetinherited

An optional design-time browseable flags set which can be applied to the underlying link

◆ LinkGrouped

Boolean LinkGrouped
getsetinherited

gets/sets whether all associated links have a grouped event

◆ LinkInformationAsToolTip

Boolean LinkInformationAsToolTip
getsetinherited

if true, then the link information associated with the shape will be displayed as tooltip information.

◆ LinkInputValue

String LinkInputValue
getsetinherited

optional value to use as input for automatic links

◆ LinkList

String LinkList
getsetinherited

A design-time list of targeted links. If there is more than one target then 'LinkGrouped' is automatically set to 'true'

◆ LinkProperty

String LinkProperty
getsetinherited

The design-time browseable/editable link property (suppliments the link address)"

Referenced by AcopSlider.applySliderSetting(), AcopUserComponent.Detach(), and AcopUserComponent.ReassignList().

◆ LinkProtocol

String LinkProtocol
getsetinherited

The link control system protocol

Referenced by AcopSlider.applySliderSetting().

◆ LinkServer

String LinkServer
getsetinherited

The design-time browseable link server (part of the link address)

◆ LinkSubSystem

String LinkSubSystem
getsetinherited

The design-time browseable link subsystem

◆ MagnetColor

Color MagnetColor
getset

background color of magnet when its state (on or off) is unknown

◆ MagnetOffColor

Color MagnetOffColor
getset

color of magnet when it is in an off state

◆ MagnetOnColor

Color MagnetOnColor
getset

color of magnet when it is in an on state

◆ MagnetShape

MagnetType MagnetShape
getset

specfies the basic magnet shape.

◆ MagnetState

ComponentState MagnetState
getset

establishes the magnet state ('on' or 'off')

◆ NumberBlinkSlots

Int32 NumberBlinkSlots
getsetinherited

set the number of blink slots for the shape component (at least 2)

◆ Orientation

DipoleOrientation Orientation
getset

establishes the magnet orientation

◆ OutOfSyncColor

Color OutOfSyncColor
getset

background color of magnet when its readback and setpoint are not in sync

◆ Precision

int Precision
getsetinherited

precision to use for floating point numbers (0 => general format)

◆ ReadBackProperty

String ReadBackProperty
getset

The property associated with the magnet read-back value

◆ RotateText

Boolean RotateText
getsetinherited

true: apply rotation angle to displayed text

◆ RotationAngle

Int32 RotationAngle
getsetinherited

rotation angle of rectangle region

◆ TextColor

Color TextColor
getsetinherited

color of display text in rectangle region

◆ TextFont

Font TextFont
getsetinherited

font of display text in rectangle region

◆ ThresholdOff

String ThresholdOff
getset

establishes the magnet 'off' threshold criterion (value .LE. threshold -> magnet is off)

◆ ThresholdOn

String ThresholdOn
getset

establishes the magnet 'on' threshold criterion (value .GE. threshold -> dipole is on)

◆ ToolTipText

String ToolTipText
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

◆ Units

String Units
getsetinherited

the value units

◆ ValueOffset

double ValueOffset
getsetinherited

if target value is a number type, then this offset will be applied following data acquisition

◆ ValueScale

double ValueScale
getsetinherited

if target value is a number type, then this offset will be applied following data acquisition

Event Documentation

◆ acopLinkError

acopError acopLinkError
inherited

Occurs when the underlying monitored link enters an error state (via acopApply or acopLinkUpdate)

Referenced by AcopUserComponent.SingleUpdate().

◆ acopLinkUpdate

acopUpdate acopLinkUpdate
inherited

Occurs when the underlying monitored link has updated its data

Referenced by AcopUserComponent.SingleUpdate().

◆ acopReset

acopResetSetting acopReset
inherited

Occurs when the control attempts to reset the setting shown to the link address


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

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