A smart Table allowing rows and columns of control system items. More...

Inheritance diagram for AcopTable:

Classes
class	AcopTableCell

class	TableCell

class	TableRow

class	ValueThreshold

Public Member Functions
delegate void	acopTableApplySelectionDelegate (object sender, AcopTable table)
	Occurs when the context menu item 'Apply Selection' has been clicked More...

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

void	ApplyInput (object sender)
	Applies the current table input values (if the input column is shown) More...

void	AssignTableEntries (object values, int row)
	Assigns the values to the table beginning at the row given More...

void	AssignTableEntries (object values, int row, int valueColumn)
	Assigns the values to the table beginning at the row given 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...

Boolean	CellIsSelected (int row, int column)
	returns the selected status of the given row and column More...

Boolean	CellIsSelected (AcopTableCell cell)
	returns the selected status of the given AcopTableCell More...

void	ClearSelection ()
	de-selects all cells. 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...

AcopTableCell []	GetCells ()
	returns an array of all table cells (minus header) More...

AcopTableCell []	GetCells (int valueColumn)
	returns an array of all table cells (minus header) 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...

AcopTableCell []	GetSelectedCells ()
	returns an array of those cells which are currently selected More...

AcopTableCell []	GetSelectedCells (int valueColumn)
	returns an array of those cells which are currently selected 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...

String	GetTableCellToolTip (int row, int column)
	Gets the tool tip text of a specific table cell More...

String	GetTableDescription (int row)
	returns the current table description for the row specified More...

String	GetTableInput (int row)
	returns the current table input value (as string) for the row specified More...

object	GetTableInputValues ()
	returns an object containing the input value specified in the 'Input' column More...

object	GetTableInputValues (int valueColumn)
	returns an object containing the input value specified in the 'Input' column More...

String	GetTableRowDescriptionToolTip (int row)
	Gets the tool tip text of a specific row description More...

String	GetTableValue (int row)
	returns the current table value (as string) for the row specified More...

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

double [][]	GetTrendPoints (int row, int depthInSeconds)
	gets a trend of history points according to the depthInSeconds 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	ResetInput ()
	resets the input values to the current readback values (if ShowInputColumn is true) More...

Boolean	RowIsSelected (int row)
	returns the selected status of the given row More...

void	SetCellIsSelected (AcopTableCell cell, Boolean value)
	sets the selected status of the given AcopTableCell More...

void	SetCellIsSelected (int row, int column, Boolean value)
	sets the selected status of the given AcopTableCell 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	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	SetTableCellToolTip (int row, int column, String toolTip)
	Sets the tool tip text of a specific table cell to the value given More...

void	SetTableDescription (int row, String value)
	sets the table description to the string value indicated. More...

void	SetTableInput (int row, String value)
	sets the input to the value given at the given table row (if ShowInputColumn is true) More...

void	SetTableInput (int row, int valueColumn, String value)
	sets the input to the value given at the given table row (if ShowInputColumn is true) More...

void	SetTableRowDescriptionToolTip (int row, String toolTip)
	Sets the tool tip text of a specific table row description to the value given More...

void	SetTableValue (int row, String value)
	sets the table value to the string value indicated. (if the table row is in AutoUpdate mode then the value will likely be overwritten). More...

void	SetTableValue (int row, int valueColumn, String value)
	sets the table cell value to the string value indicated. (if the table row is in AutoUpdate mode then the value will likely be overwritten). More...

void	SetValueBackColor (Color value, int row)
	Sets the value cells at the given row to the desired Back Color More...

void	SetValueBackColor (Color value, int row, int column)
	Sets the value cell at the given row and column to the desired Back Color More...

void	SetValueForeColor (Color value, int row)
	Sets the value cells at the given row to the desired ForeColor More...

void	SetValueForeColor (Color value, int row, int column)
	Sets the value cell at the given row and column to the desired ForeColor 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	AllowSelections `[get, set]`
	true: allow selection of table value cells and fire Apply event in context menu More...

Boolean	ApplyAcopLinkUpdateAfterAutoUpdate `[get, set]`
	Determines the firing order of a user-defined acopLinkUpdate delegate More...

Boolean	ApplyBackColorListToColumns `[get, set]`
	apply the BackColor List to column entries if NumberValueColumns > 1 More...

ApplyEventSettingType	ApplyEventOrder `[get, set]`
	Determines the firing order of a user-defined acopApply delegate More...

Boolean	ApplyForeColorListToColumns `[get, set]`
	apply the ForeColor List to column entries if NumberValueColumns > 1 More...

Boolean	ApplyInputContextMenu `[get, set]`
	If 'true' show apply input context menu over each input cell 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 table cells More...

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

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

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

Boolean	CloseLinkOnMinimized `[get, set]`
	If true the Link will be closed if the form is minimized More...

String	ControlPanelApplication `[get, set]`
	provides the name of an application to use as a control panel. More...

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

int	DescriptionColumnSize `[get, set]`
	Desired description column width in percent (if DescriptionHeader = true) More...

Font	DescriptionFont `[get, set]`
	Font to apply to the description column More...

String	DescriptionHeader `[get, set]`
	Table description header text More...

String []	DescriptionList `[get, set]`
	Supply a specific array of description strings to use in the table Description column More...

Boolean	DisplayAsBits `[get, set]`
	true: display bit breakdown (applies to a single link returning a number) 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...

UInt32	DisplayBitMask `[get, set]`
	Mask giving the relevant bits to use if DisplayAsBits is true More...

DisplayBitsStyleSetting	DisplayBitsStyle `[get, set]`
	determines how bit values are displayed in the table (if DisplayAsBits is true) More...

Font	DisplayFont `[get, set]`
	Font to apply to table cells More...

Boolean	DisplayFullString `[get, set]`
	if 'true' then the full string representation of returned data will be display in the associated table cell. More...

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

TableLayoutPanelCellBorderStyle	HeaderBorderStyle `[get, set]`
	Border style of this acop table header More...

Color	HeaderForeColor `[get, set]`
	ForeColor of the table header text More...

Color	InputBackColor `[get, set]`
	BackColor to display in the input column when it is shown More...

Color	InputForeColor `[get, set]`
	ForeColor to display in the input column when it is shown More...

Color	InputForeColorOutOfSync `[get, set]`
	ForeColor to display in the input column when it is shown and the data contents are out of sync with the readback values More...

Color	LabelBackColor `[get, set]`
	BackColor to apply to the value cell More...

ListItemEditorValue	LabelBackColorList `[get, set]`
	Specifies a list of background colors to use for value entries More...

BorderStyle	LabelBorderStyle `[get, set]`
	Border style of the value label cells within the table More...

Color	LabelForeColor `[get, set]`
	ForeColor to apply to the value cell More...

ListItemEditorValue	LabelForeColorList `[get, set]`
	Specifies a list of foreground colors to use for value entries 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...

int	MaximumRows `[get, set]`
	maximum number of table rows More...

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

int	NumberColumns `[get, set]`
	initial number of table value columns More...

int	NumberInputColumns `[get, set]`
	initial number of table input columns (less than or equal to number of value columns) More...

int	NumberRows `[get, set]`
	initial number of table rows 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...

Color	SelectionBackColor `[get, set]`
	BackColor to display when a cell is selected More...

Color	SelectionForeColor `[get, set]`
	ForeColor to display when a cell is selected More...

Boolean	ShowDescriptionColumn `[get, set]`
	true: show the description column More...

Boolean	ShowHeader `[get, set]`
	true: show the table header More...

Boolean	ShowInputColumn `[get, set]`
	true: show the value input column More...

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

Boolean	TableAutoScroll `[get, set]`
	true: allow scroll bars if the number of table rows exceeds the table layout size More...

TableLayoutPanelCellBorderStyle	TableBorderStyle `[get, set]`
	Border style of this acop table More...

ContentAlignment	TableDescriptionAlignment `[get, set]`
	text aligment for table description cells More...

ContentAlignment	TableValueAlignment `[get, set]`
	text aligment for table values More...

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

ThresholdListEditorValue	ThresholdList `[get, set]`
	supplies a list of threshold criteria to be used for a set of grouped links 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...

String	ValueHeader `[get, set]`
	Table readback value header text More...

Events
acopApplySetting	acopApply
	Occurs when the control attempts to apply the setting shown to the link address More...

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

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

acopResetSetting	acopReset
	Occurs when the control attempts to reset the setting shown to the link address More...

acopTableClickDelegate	acopTableClick
	Occurs a table value has been clicked More...

Detailed Description

A smart Table allowing rows and columns of control system items.

A displayed value column can optionally be associated with an input column, where attribute settings can be changed and applied to the associated server via a context-menu.

Member Function Documentation

◆ acopTableApplySelectionDelegate()

delegate void acopTableApplySelectionDelegate	(	object	sender,
		AcopTable	table
	)

Occurs when the context menu item 'Apply Selection' has been clicked

Parameters

sender
table

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

◆ ApplyInput()

void ApplyInput ( object sender )

inline

Applies the current table input values (if the input column is shown)

You can use this method in code (e.g. behind a button) to send the given input values to the target(s) in lieu of using the context menu

Parameters

sender the sender object (e.g. the button whose click event calls this method)

◆ AssignTableEntries() [1/2]

void AssignTableEntries	(	object	values,
		int	row
	)

inline

Assigns the values to the table beginning at the row given

Parameters

values	the array or single value to be assigned to the row entry
row	the targeted table row

◆ AssignTableEntries() [2/2]

void AssignTableEntries	(	object	values,
		int	row,
		int	valueColumn
	)

inline

Assigns the values to the table beginning at the row given

Parameters

values	the array or single value to be assigned to the row entry
row	the targeted table row
valueColumn	the targeted table value column

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

◆ CellIsSelected() [1/2]

Boolean CellIsSelected	(	int	row,
		int	column
	)

inline

returns the selected status of the given row and column

Parameters

row	is the desired table row
column	is the desired table column

Returns: true if the cell is in a selected state

◆ CellIsSelected() [2/2]

Boolean CellIsSelected ( AcopTableCell cell )

inline

returns the selected status of the given AcopTableCell

Parameters

cell	is the desired cell

Returns: true if the cell is in a selected state

◆ ClearSelection()

void ClearSelection ( )

inline

de-selects all cells.

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

◆ GetCells() [1/2]

AcopTableCell [] GetCells ( )

inline

returns an array of all table cells (minus header)

Returns: an array of all table cells

◆ GetCells() [2/2]

AcopTableCell [] GetCells ( int valueColumn )

inline

returns an array of all table cells (minus header)

Parameters

valueColumn the specific column for which the cells are desired

Returns: an array of all table cells

◆ 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

◆ GetSelectedCells() [1/2]

AcopTableCell [] GetSelectedCells ( )

inline

returns an array of those cells which are currently selected

Returns: an array of those cells which are currently selected

◆ GetSelectedCells() [2/2]

AcopTableCell [] GetSelectedCells ( int valueColumn )

inline

returns an array of those cells which are currently selected

Parameters

valueColumn the specific column for which the cells are desired

Returns: an array of those cells which are currently selected

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

◆ GetTableCellToolTip()

String GetTableCellToolTip	(	int	row,
		int	column
	)

inline

Gets the tool tip text of a specific table cell

Parameters

row	the table cell's row
column	the table cell's column

Returns: the tool tip text of a specific table cell

◆ GetTableDescription()

String GetTableDescription ( int row )

inline

returns the current table description for the row specified

Parameters

row	the targeted row

Returns: the current table description for the row specified

◆ GetTableInput()

String GetTableInput ( int row )

inline

returns the current table input value (as string) for the row specified

Parameters

row	the row containing the desired input value

Returns: the current table input value for the row specified

◆ GetTableInputValues() [1/2]

object GetTableInputValues ( )

inline

returns an object containing the input value specified in the 'Input' column

Returns: an object containing the input value specified in the 'Input' column

◆ GetTableInputValues() [2/2]

object GetTableInputValues ( int valueColumn )

inline

returns an object containing the input value specified in the 'Input' column

Parameters

valueColumn the table value column containing the desired input values

Returns: an object containing the input value specified in the 'Input' column

◆ GetTableRowDescriptionToolTip()

String GetTableRowDescriptionToolTip ( int row )

inline

Gets the tool tip text of a specific row description

Parameters

row	the table row

Returns: the tool tip text of a specific row description

◆ GetTableValue()

String GetTableValue ( int row )

inline

returns the current table value (as string) for the row specified

Parameters

row	the targeted row

Returns: the current table value (as string) for the row specified

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

◆ GetTrendPoints()

double [][] GetTrendPoints	(	int	row,
		int	depthInSeconds
	)

inline

gets a trend of history points according to the depthInSeconds

Parameters

row	table row containing the desired link
depthInSeconds	start time in UTC (seconds since Jan 1 1970)

Returns

References AcopUserComponent.getUtcNow().

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

◆ ResetInput()

void ResetInput ( )

inline

resets the input values to the current readback values (if ShowInputColumn is true)

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

◆ RowIsSelected()

Boolean RowIsSelected ( int row )

inline

returns the selected status of the given row

Parameters

row	is the desired table row

Returns: true if the row is in a selected state

◆ SetCellIsSelected() [1/2]

void SetCellIsSelected	(	AcopTableCell	cell,
		Boolean	value
	)

inline

sets the selected status of the given AcopTableCell

Parameters

cell	is the desired cell
value	is the desired selected state

◆ SetCellIsSelected() [2/2]

void SetCellIsSelected	(	int	row,
		int	column,
		Boolean	value
	)

inline

sets the selected status of the given AcopTableCell

Parameters

row	is the desired table row
column	is the desired table column
value	is the desired selected state

◆ SetControlPanel() [1/2]

void SetControlPanel ( Form value )

inline

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

value The form instance to be displayed.

◆ SetControlPanel() [2/2]

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.

◆ SetTableCellToolTip()

void SetTableCellToolTip	(	int	row,
		int	column,
		String	toolTip
	)

inline

Sets the tool tip text of a specific table cell to the value given

Parameters

row	the table cell's row
column	the table cell's column
toolTip	the desired tool tip text

◆ SetTableDescription()

void SetTableDescription	(	int	row,
		String	value
	)

inline

sets the table description to the string value indicated.

Parameters

row	the targeted table row
value	the desired table description

◆ SetTableInput() [1/2]

void SetTableInput	(	int	row,
		String	value
	)

inline

sets the input to the value given at the given table row (if ShowInputColumn is true)

Parameters

row	the desired table row
value	the desired input value

◆ SetTableInput() [2/2]

void SetTableInput	(	int	row,
		int	valueColumn,
		String	value
	)

inline

sets the input to the value given at the given table row (if ShowInputColumn is true)

Parameters

row	the desired table row
valueColumn	the desired table value column
value	the desired input value

◆ SetTableRowDescriptionToolTip()

void SetTableRowDescriptionToolTip	(	int	row,
		String	toolTip
	)

inline

Sets the tool tip text of a specific table row description to the value given

Parameters

row	the table description row
toolTip	the desired tool tip text

◆ SetTableValue() [1/2]

void SetTableValue	(	int	row,
		String	value
	)

inline

sets the table value to the string value indicated. (if the table row is in AutoUpdate mode then the value will likely be overwritten).

Parameters

row	the targeted table row
value	the desired table value

◆ SetTableValue() [2/2]

void SetTableValue	(	int	row,
		int	valueColumn,
		String	value
	)

inline

sets the table cell value to the string value indicated. (if the table row is in AutoUpdate mode then the value will likely be overwritten).

Parameters

row	the targeted table row
valueColumn	the targeted table column
value	the desired table value

◆ SetValueBackColor() [1/2]

void SetValueBackColor	(	Color	value,
		int	row
	)

inline

Sets the value cells at the given row to the desired Back Color

Parameters

value	the desired Back Color for the value cell entry
row	the table row containing the cell

◆ SetValueBackColor() [2/2]

void SetValueBackColor	(	Color	value,
		int	row,
		int	column
	)

inline

Sets the value cell at the given row and column to the desired Back Color

Parameters

value	the desired Back Color for the value cell entry
row	the table row containing the cell
column	the table column containing the cell

◆ SetValueForeColor() [1/2]

void SetValueForeColor	(	Color	value,
		int	row
	)

inline

Sets the value cells at the given row to the desired ForeColor

Parameters

value	the desired ForeColor for the value cell entry
row	the table row containing the cell

◆ SetValueForeColor() [2/2]

void SetValueForeColor	(	Color	value,
		int	row,
		int	column
	)

inline

Sets the value cell at the given row and column to the desired ForeColor

Parameters

value	the desired ForeColor for the value cell entry
row	the table row containing the cell
column	the table column containing the cell

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

getsetinherited

the prefered location to apply units (default = description)

◆ AutoLinkAttach

bool AutoLinkAttach

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

Table readback value header text

Event Documentation

◆ acopApply

acopApplySetting acopApply

inherited

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

◆ 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

◆ acopTableClick

acopTableClickDelegate acopTableClick

Occurs a table value has been clicked

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

AcopTable.cs
AcopTable.Designer.cs

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ acopTableApplySelectionDelegate()

◆ AddColorToList() [1/2]

◆ AddColorToList() [2/2]

◆ ApplyInput()

◆ AssignTableEntries() [1/2]

◆ AssignTableEntries() [2/2]

◆ Attach() [1/5]

◆ Attach() [2/5]

◆ Attach() [3/5]

◆ Attach() [4/5]

◆ Attach() [5/5]

◆ CellIsSelected() [1/2]

◆ CellIsSelected() [2/2]

◆ ClearSelection()

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

◆ GetCells() [1/2]

◆ GetCells() [2/2]

◆ GetColorList()

◆ GetDataTag()

◆ GetFlags()

◆ GetLink()

◆ GetLinkOutput()

◆ GetLinkOutputChannelNames()

◆ GetLinkOutputXAxis()

◆ GetLinkOutputYAxis()

◆ GetOutputCompletionLength()

◆ GetOutputDataObject() [1/2]

◆ GetOutputDataObject() [2/2]

◆ GetSelectedCells() [1/2]

◆ GetSelectedCells() [2/2]

◆ GetStatus()

◆ GetStatusString()

◆ GetTableCellToolTip()

◆ GetTableDescription()

◆ GetTableInput()

◆ GetTableInputValues() [1/2]

◆ GetTableInputValues() [2/2]

◆ GetTableRowDescriptionToolTip()

◆ GetTableValue()

◆ GetTimeStamp()

◆ GetTrendPoints()

◆ getUtcNow()

◆ IsAttached()

◆ LinkUpdateInvoker()

◆ Reassign()

◆ ReassignList()

◆ Reset() [1/2]

◆ Reset() [2/2]

◆ ResetInput()

◆ RowIsSelected()

◆ SetCellIsSelected() [1/2]

◆ SetCellIsSelected() [2/2]

◆ SetControlPanel() [1/2]

◆ SetControlPanel() [2/2]

◆ SetTableCellToolTip()

◆ SetTableDescription()

◆ SetTableInput() [1/2]

◆ SetTableInput() [2/2]

◆ SetTableRowDescriptionToolTip()

◆ SetTableValue() [1/2]

◆ SetTableValue() [2/2]

◆ SetValueBackColor() [1/2]