A non-GUI component which can be attached to one or more control system elements. More...

Inheritance diagram for AcopComponent:

Classes
class	LinkContextConverter

class	LinkDeviceConverter

class	LinkFlagsConverter

class	LinkPropertyConverter

class	LinkProtocolConverter

class	LinkServerConverter

class	LinkSubSystemConverter

Public Member Functions
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 reference)
	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...

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

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

Int32	GetOutputDataAsInteger ()
	get the last transfered data as an integer More...

double	GetOutputDataAsNumber ()
	get the last transfered data as a number More...

string	GetOutputDataAsString ()
	get the last transfered data as a string More...

string []	GetOutputDataAsStringArray ()
	get the last transfered data as a string array 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...

void	LinkUpdateInvoker (Control control, 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	Reassign (String Context, String Server, String Device, String Property)
	Reassigns the current bound default link to the address parameters given. More...

void	Reset ()
	Closes all monitored links. If AutoAttachLink is 'true' then the link currently bound to the component will re-link. More...

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

int	DefaultMonitorInterval `[get, set]`
	the default monitoring interval in msec 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...

int	LinkDelay `[get, set]`
	gives a delay time in milliseconds to suspend the current thread following an auto attach 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...

bool	LinkGrouped `[get, set]`
	if set to true, then multiple assigned links will fire a single receive event when all links have completed their update cycle More...

String	LinkInputValue `[get, set]`
	optional value to use as input for automatic links 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...

Events
acopUpdate	acopLinkUpdate
	Occurs when the underlying monitored link has updated its data More...

Detailed Description

A non-GUI component which can be attached to one or more control system elements.

Member Function Documentation

◆ Attach() [1/6]

int Attach ( )

inline

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 AcopComponent.GetFlags().

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

◆ Attach() [2/6]

int Attach ( object reference )

inline

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

Parameters

reference Any 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 AcopComponent.Attach(), and AcopComponent.GetFlags().

◆ Attach() [3/6]

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

inline

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

Parameters

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

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

References Link.GetLinkId().

◆ Attach() [4/6]

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

inline

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

Parameters

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

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

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

◆ Attach() [5/6]

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

inline

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

Parameters

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
interval	An update interval (or timeout) in milliseconds
reference	Any 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() [6/6]

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

inline

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

Parameters

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

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

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

◆ Detach() [1/5]

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

inline

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

Parameters

Protocol	Control system protocol
Address	The link address
Property	The link property
DataOut	The output data object
DataIn	The input data object

Returns: 0 upon success or -1 on error

Referenced by AcopMagnet.Dispose().

◆ Detach() [2/5]

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

inline

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

Parameters

Address	The link address
Property	The link property
DataOut	The output data object
DataIn	The input data object

Returns: 0 upon success or -1 on error

References AcopComponent.Detach().

◆ Detach() [3/5]

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

inline

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

Parameters

Protocol	Control system protocol
Address	The link address
Property	The link property

Returns: 0 upon success or -1 on error

References AcopComponent.Detach().

◆ Detach() [4/5]

int Detach	(	String	Address,
		String	Property
	)

inline

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

Parameters

Address	The link address
Property	The link property

Returns: 0 upon success or -1 on error

References AcopComponent.Detach().

◆ Detach() [5/5]

int Detach ( )

inline

Detaches all links attached to the acop control.

Returns: 0 upon success or -1 on error

Referenced by AcopComponent.Detach().

◆ Execute() [1/5]

int Execute ( )

inline

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 AcopComponent.GetFlags().

Referenced by AcopComponent.Execute().

◆ Execute() [2/5]

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

inline

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

Parameters

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

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
	)

inline

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

Parameters

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

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

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

◆ Execute() [4/5]

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

inline

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

Parameters

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

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
	)

inline

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

Parameters

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

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

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

◆ GetDataTag()

int GetDataTag ( )

inline

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 )

inline

Gets the integer flag representation of the input flags string

Parameters

flags

Returns: the integer flag representation of the input flags string

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

◆ GetLinkOutput()

object GetLinkOutput ( )

inline

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

inline

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

inline

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

inline

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

inline

Gets the last delivered link output completion length.

Returns: The last delivered link output completion length.

References Link.GetOutputCompletionLength().

◆ GetOutputDataAsInteger()

Int32 GetOutputDataAsInteger ( )

inline

get the last transfered data as an integer

Returns: the last transfered data as an integer

References Link.GetOutputDataAsInteger().

◆ GetOutputDataAsNumber()

double GetOutputDataAsNumber ( )

inline

get the last transfered data as a number

Returns: the last transfered data as a number

◆ GetOutputDataAsString()

string GetOutputDataAsString ( )

inline

get the last transfered data as a string

Returns: the last transfered data as a string

References Link.GetOutputDataAsString().

◆ GetOutputDataAsStringArray()

string [] GetOutputDataAsStringArray ( )

inline

get the last transfered data as a string array

Returns: the last transfered data as a string array

References Link.GetOutputDataAsString().

◆ GetOutputDataObject() [1/2]

object GetOutputDataObject ( )

inline

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 )

inline

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

Parameters

instance the desired overload

Returns: the output data object appropriate to the current link address

◆ GetStatus()

int GetStatus ( )

inline

Gets the current link status as an integer value

Returns: The current link status as an integer value

References Link.GetStatus().

◆ GetStatusString()

String GetStatusString ( )

inline

Gets the current transport link status as a string

Returns: The current transport link status as a string

References Link.GetStatusString().

◆ GetTimeStamp()

double GetTimeStamp ( )

inline

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

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

References Link.GetTimeStamp().

◆ LinkUpdateInvoker()

void LinkUpdateInvoker	(	Control	control,
		acopUpdate	updater,
		object	sender,
		Link	lnk
	)

inline

An invoker helper for cases where InvokeRequired is needed

Parameters

control	the parent control of this AcopLink
updater	is the delegate to invoke
sender	is the sender object
lnk	is the Link object

◆ Reassign() [1/2]

int Reassign	(	String	Address,
		String	Property
	)

inline

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

Parameters

Address	the desired new target link address
Property	the desired new target link property

Returns: a positive link handle to the new link upon success, otherwise -1.

References AcopComponent.Attach().

Referenced by AcopComponent.Reassign().

◆ Reassign() [2/2]

int Reassign	(	String	Context,
		String	Server,
		String	Device,
		String	Property
	)

inline

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

Parameters

Context	the desired new target link context
Server	the desired new target link server
Device	the desired new target link device
Property	the desired new target link property

Returns: a positive link handle to the new link upon success, otherwise -1.

References AcopComponent.Reassign().

◆ Reset()

void Reset ( )

inline

Closes all monitored links. If AutoAttachLink is 'true' then the link currently bound to the component will re-link.

Referenced by AcopUtils.ResetAcopLinks().

Property Documentation

◆ AutoLinkAttach

bool AutoLinkAttach

getset

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

◆ AutoLinkCapacity

int AutoLinkCapacity

getset

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

◆ DefaultMonitorInterval

int DefaultMonitorInterval

getset

the default monitoring interval in msec

◆ LinkAddress

String LinkAddress

getset

identifies the transport link target. The target end point is given by the LinkAddress and the LinkProperty.

◆ LinkContext

String LinkContext

getset

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

◆ LinkDelay

int LinkDelay

getset

gives a delay time in milliseconds to suspend the current thread following an auto attach

◆ LinkDevice

String LinkDevice

getset

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

◆ LinkFlags

String LinkFlags

getset

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

◆ LinkGrouped

bool LinkGrouped

getset

if set to true, then multiple assigned links will fire a single receive event when all links have completed their update cycle

◆ LinkInputValue

String LinkInputValue

getset

optional value to use as input for automatic links

◆ LinkProperty

String LinkProperty

getset

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

◆ LinkProtocol

String LinkProtocol

getset

the link control system protocol

◆ LinkServer

String LinkServer

getset

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

◆ LinkSubSystem

String LinkSubSystem

getset

the design-time browseable link subsystem

Event Documentation

◆ acopLinkUpdate

acopUpdate acopLinkUpdate

Occurs when the underlying monitored link has updated its data

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

AcopComponent.cs

Classes

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ Attach() [1/6]

◆ Attach() [2/6]

◆ Attach() [3/6]

◆ Attach() [4/6]

◆ Attach() [5/6]

◆ Attach() [6/6]

◆ Detach() [1/5]

◆ Detach() [2/5]

◆ Detach() [3/5]

◆ Detach() [4/5]

◆ Detach() [5/5]

◆ Execute() [1/5]

◆ Execute() [2/5]

◆ Execute() [3/5]

◆ Execute() [4/5]

◆ Execute() [5/5]

◆ GetDataTag()

◆ GetFlags()

◆ GetLinkOutput()

◆ GetLinkOutputChannelNames()

◆ GetLinkOutputXAxis()

◆ GetLinkOutputYAxis()

◆ GetOutputCompletionLength()

◆ GetOutputDataAsInteger()

◆ GetOutputDataAsNumber()

◆ GetOutputDataAsString()

◆ GetOutputDataAsStringArray()

◆ GetOutputDataObject() [1/2]

◆ GetOutputDataObject() [2/2]

◆ GetStatus()

◆ GetStatusString()

◆ GetTimeStamp()

◆ LinkUpdateInvoker()

◆ Reassign() [1/2]

◆ Reassign() [2/2]

◆ Reset()

Property Documentation

◆ AutoLinkAttach

◆ AutoLinkCapacity

◆ DefaultMonitorInterval

◆ LinkAddress

◆ LinkContext

◆ LinkDelay

◆ LinkDevice

◆ LinkFlags

◆ LinkGrouped

◆ LinkInputValue

◆ LinkProperty

◆ LinkProtocol

◆ LinkServer

◆ LinkSubSystem

Event Documentation

◆ acopLinkUpdate