A smart Label for display control system items. More...

Inheritance diagram for AcopLabel:

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

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	AddToTripLog `[get, set]`
	Determines whether treshold violations are added to the application's trip log More...

Boolean	AllowScientificNotation `[get, set]`
	if 'true' then very small and very large numbers will be displayed in scientific notation 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...

BlinkMode	Blink `[get, set]`
	set the blink mode for the label More...

Int32	BlinkIntensity `[get, set]`
	set the blink intensity for the label (up to 100% lighter or -100% darker) More...

Int32	BlinkInterval `[get, set]`
	set the blink interval (msec) for the label More...

Int32	BlinkSlot `[get, set]`
	set the blink slot for the label (0 up to the number of slots) More...

ContentAlignment	CaptionAlignment `[get, set]`
	provides the Caption text aligment More...

Color	CaptionBackColor `[get, set]`
	Default BackColor to use for the Caption More...

Color	CaptionForeColor `[get, set]`
	Default ForeColor to use for the Caption More...

int	CaptionWidth `[get, set]`
	if non-zero, provides the desired caption width (if ShowDescription is true). Else the width of the description text is used 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...

int	DefaultMonitorInterval `[get, set]`
	The default monitoring interval in msec More...

String	Description `[get, set]`
	if non-empty, then the string provided will be used as the Caption text (else the property's discovered description) More...

Boolean	DisplayAsMultiChannel `[get, set]`
	if true, then the label contents will be a multi-line representation of all values if the targeted data is a multi-channel array More...

Boolean	DisplayAsString `[get, set]`
	If 'true' then the string representation/portion of the returned data will be displayed even if a number is available More...

String	DisplayValue `[get, set]`
	if non-empty then the displayed value upon update will be the value given More...

String	ErrorValue `[get, set]`
	value to use when there are link errors More...

ContentAlignment	LabelAlignment `[get, set]`
	provides the Lable text aligment More...

Color	LabelBackColor `[get, set]`
	Default BackColor to use for the value label More...

BorderStyle	LabelBorderStyle `[get, set]`
	The border style of the embedded label text More...

Color	LabelForeColor `[get, set]`
	Default ForeColor to use for the value label More...

Color	LabelHiWarnBackColor `[get, set]`
	BackColor to use if number value is greater than ThresholdHiWarn or if string value does not equal ThresholdMatch More...

Color	LabelHiWarnForeColor `[get, set]`
	ForeColor to use if number value is greater than ThresholdHiWarn or if string value does not equal ThresholdMatch More...

Color	LabelLowWarnBackColor `[get, set]`
	BackColor to use if number value is less than ThresholdLowWarn or if string value equals ThresholdMatch More...

Color	LabelLowWarnForeColor `[get, set]`
	ForeColor to use if number value is less than ThresholdLowWarn or if string value equals ThresholdMatch 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...

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

Int32	NumberBlinkSlots `[get, set]`
	set the number of blink slots for the label (at least 2) More...

TextOrientation	Orientation `[get, set]`
	set the AcopLabel orientation (non-horizontal will turn off the description caption) More...

int	Precision `[get, set]`
	precision to use for floating point numbers (0 => general format) More...

String	PreferredNumberFormat `[get, set]`
	Establishes a specific format for use in a string representation of numerical data More...

Boolean	ShowDescription `[get, set]`
	if true, then both the Label and its Caption will be visible More...

Boolean	ShowSplitter `[get, set]`
	if true, then the splitter between Caption and Label will be visible (if ShowDescription is true) More...

Color	SplitterColor `[get, set]`
	Color to use for the splitter (when visible) More...

int	SplitterWidth `[get, set]`
	if non-zero, provides the desired splitter width (if ShowDescription and ShowSplitter are both true) More...

String	StringParsingDelimiter `[get, set]`
	Establishes a string separater for use in a string representation of compound data More...

double	ThresholdHighWarn `[get, set]`
	if the link data is numerical, then the threshold provided is used for comparisons with the monitored data More...

double	ThresholdLowWarn `[get, set]`
	if the link data is numerical, then the threshold provided is used for comparisons with the monitored data More...

String	ThresholdMatch `[get, set]`
	if non-empty and the link data is non-numerical, then the string provided is used for comparisons with the monitored data 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 Label for display control system items.

All channels in a Multi-Channel Array can also be displayed in a single label.

Member Function Documentation

◆ AddColorToList() [1/2]

void AddColorToList ( String color )

inlineinherited

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

Parameters

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

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

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

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

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

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

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

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

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

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

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

Protocol	Control system protocol
Address	The link address
Property	The 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

Address	The link address
Property	The 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

disposing true if managed resources should be disposed; otherwise, false.

◆ 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

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
	)

inlineinherited

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

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
	)

inlineinherited

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

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

updater	is the delegate to invoke
sender	is the sender object
lnk	is the Link object

◆ Reassign()

int Reassign	(	String	Address,
		String	Property
	)

inlineinherited

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

newGroupList	is the ';' separated list of grouped link addresses
newAddr	is the new assigned LinkAddress
newPrp	is 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

allLinks if 'true' then all bound links are examined.

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

◆ SetControlPanel()

void SetControlPanel ( String value )

inline

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

value The name of the application process to launch.

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

◆ AddToTripLog

Boolean AddToTripLog

getset

Determines whether treshold violations are added to the application's trip log

◆ AllowScientificNotation

Boolean AllowScientificNotation

getset

if 'true' then very small and very large numbers will be displayed in scientific notation

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

◆ Blink

BlinkMode Blink

getset

set the blink mode for the label

◆ BlinkIntensity

Int32 BlinkIntensity

getset

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

◆ BlinkInterval

Int32 BlinkInterval

getset

set the blink interval (msec) for the label

◆ BlinkSlot

Int32 BlinkSlot

getset

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

◆ CaptionAlignment

ContentAlignment CaptionAlignment

getset

provides the Caption text aligment

◆ CaptionBackColor

Color CaptionBackColor

getset

Default BackColor to use for the Caption

◆ CaptionForeColor

Color CaptionForeColor

getset

Default ForeColor to use for the Caption

◆ CaptionWidth

int CaptionWidth

getset

if non-zero, provides the desired caption width (if ShowDescription is true). Else the width of the description text is used

◆ CloseLinkOnMinimized

Boolean CloseLinkOnMinimized

getsetinherited

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

◆ ControlPanelApplication

String ControlPanelApplication

getset

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

◆ DefaultMonitorInterval

int DefaultMonitorInterval

getsetinherited

The default monitoring interval in msec

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

◆ Description

String Description

getsetinherited

if non-empty, then the string provided will be used as the Caption text (else the property's discovered description)

◆ DisplayAsMultiChannel

Boolean DisplayAsMultiChannel

getsetinherited

if true, then the label contents will be a multi-line representation of all values if the targeted data is a multi-channel array

◆ DisplayAsString

Boolean DisplayAsString

getset

If 'true' then the string representation/portion of the returned data will be displayed even if a number is available

◆ DisplayValue

String DisplayValue

getset

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

◆ ErrorValue

String ErrorValue

getsetinherited

value to use when there are link errors

◆ LabelAlignment

ContentAlignment LabelAlignment

getset

provides the Lable text aligment

◆ LabelBackColor

Color LabelBackColor

getset

Default BackColor to use for the value label

◆ LabelBorderStyle

BorderStyle LabelBorderStyle

getset

The border style of the embedded label text

◆ LabelForeColor

Color LabelForeColor

getset

Default ForeColor to use for the value label

◆ LabelHiWarnBackColor

Color LabelHiWarnBackColor

getset

BackColor to use if number value is greater than ThresholdHiWarn or if string value does not equal ThresholdMatch

◆ LabelHiWarnForeColor

Color LabelHiWarnForeColor

getset

ForeColor to use if number value is greater than ThresholdHiWarn or if string value does not equal ThresholdMatch

◆ LabelLowWarnBackColor

Color LabelLowWarnBackColor

getset

BackColor to use if number value is less than ThresholdLowWarn or if string value equals ThresholdMatch

◆ LabelLowWarnForeColor

Color LabelLowWarnForeColor

getset

ForeColor to use if number value is less than ThresholdLowWarn or if string value equals ThresholdMatch

◆ 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

◆ 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

◆ NumberBlinkSlots

Int32 NumberBlinkSlots

getset

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

◆ Orientation

TextOrientation Orientation

getset

set the AcopLabel orientation (non-horizontal will turn off the description caption)

◆ Precision

int Precision

getsetinherited

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

◆ PreferredNumberFormat

String PreferredNumberFormat

getset

Establishes a specific format for use in a string representation of numerical data

◆ ShowDescription

Boolean ShowDescription

getset

if true, then both the Label and its Caption will be visible

◆ ShowSplitter

Boolean ShowSplitter

getset

if true, then the splitter between Caption and Label will be visible (if ShowDescription is true)

◆ SplitterColor

Color SplitterColor

getset

Color to use for the splitter (when visible)

◆ SplitterWidth

int SplitterWidth

getset

if non-zero, provides the desired splitter width (if ShowDescription and ShowSplitter are both true)

◆ StringParsingDelimiter

String StringParsingDelimiter

getset

Establishes a string separater for use in a string representation of compound data

◆ ThresholdHighWarn

double ThresholdHighWarn

getset

if the link data is numerical, then the threshold provided is used for comparisons with the monitored data

◆ ThresholdLowWarn

double ThresholdLowWarn

getset

if the link data is numerical, then the threshold provided is used for comparisons with the monitored data

◆ ThresholdMatch

String ThresholdMatch

getset

if non-empty and the link data is non-numerical, then the string provided is used for comparisons with the monitored data

◆ 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

getset

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

◆ ValueScale

double ValueScale

getset

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:

AcopLabel.cs
AcopLabel.Designer.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddColorToList() [1/2]

◆ AddColorToList() [2/2]

◆ Attach() [1/5]

◆ Attach() [2/5]

◆ Attach() [3/5]

◆ Attach() [4/5]

◆ Attach() [5/5]

◆ Detach() [1/5]

◆ Detach() [2/5]

◆ Detach() [3/5]

◆ Detach() [4/5]

◆ Detach() [5/5]

◆ Dispose()

◆ Execute() [1/5]

◆ Execute() [2/5]

◆ Execute() [3/5]

◆ Execute() [4/5]

◆ Execute() [5/5]

◆ GetColorList()

◆ GetDataTag()

◆ GetFlags()

◆ GetLink()

◆ GetLinkOutput()

◆ GetLinkOutputChannelNames()

◆ GetLinkOutputXAxis()

◆ GetLinkOutputYAxis()

◆ GetOutputCompletionLength()

◆ GetOutputDataObject() [1/2]

◆ GetOutputDataObject() [2/2]

◆ GetStatus()

◆ GetStatusString()

◆ GetTimeStamp()

◆ getUtcNow()

◆ IsAttached()

◆ LinkUpdateInvoker()

◆ Reassign()

◆ ReassignList()

◆ Reset() [1/2]

◆ Reset() [2/2]

◆ SetControlPanel()

◆ SingleUpdate()

Property Documentation

◆ AcopReferenceObject

◆ AddToTripLog

◆ AllowScientificNotation

◆ ApplyAcopLinkUpdateAfterAutoUpdate

◆ ApplyLocation

◆ AutoLinkAttach

◆ AutoLinkCapacity

◆ AutoLinkUpdate

◆ Blink

◆ BlinkIntensity

◆ BlinkInterval

◆ BlinkSlot

◆ CaptionAlignment

◆ CaptionBackColor

◆ CaptionForeColor

◆ CaptionWidth

◆ CloseLinkOnMinimized

◆ ControlPanelApplication

◆ DefaultMonitorInterval

◆ Description

◆ DisplayAsMultiChannel

◆ DisplayAsString

◆ DisplayValue

◆ ErrorValue

◆ LabelAlignment

◆ LabelBackColor

◆ LabelBorderStyle

◆ LabelForeColor

◆ LabelHiWarnBackColor

◆ LabelHiWarnForeColor

◆ LabelLowWarnBackColor