The following public methods are exposed by the TPRI.ToggleButton class.

Public 

Function 

tValueReset() As Integer

Description:

Triggered when the control is Reset the display of the object to indicate that the button has not been clicked.

ParametersReturn Value:

Sender

The source of the event.

e

The The value originally contained in the object.

Remarks:

This function is called while updating modified data back to the server.  It provides a single function to get the new value contained in the object and reset the object to wait for the next update.

Public Function isClicked() As Boolean

Description:

Indicate whether or not the button is currently clicked.

Return Value:

The current click state.

The following events are exposed by the TPRI.ToggleButton class.

Public Event Click( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

Triggered when the control is clicked.

Parameters:

Sender

The source of the event.

e

The possible argument of the event.

Public Event ErrorTerminate( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

The event is raised when a serious error has occurred in the control.

Parameters:

Sender

The source of the event.

e

Event argument.  This will always be nothing.

The following properties are exposed by the TPRI.DataSetInfo class.

[TABLE]

The following public methods are exposed by the TPRI.DataSetInfo object.

Public Sub Initialize( _
ByVal host As String, _
ByVal page As String, _
Optional ByVal loadLast As Boolean = True _
)

Description:

Initialize the object.

Parameters:

host

Name of the host to which the object should connect.

page

Name of parent page. This is used for storing the most recently used data set associated with a particular page.

loadLast

Flag to load the most recently used data set.

Remarks:

This function must be called before the object can be used to access a data set.

Public Function LoadDataSet( _
Optional ByVal dsName As String = "" _
) As Integer

Description:

Load the specified data set.

Parameters:

dsName

Name of the data set to load.  If none is specified the Load Data Set form is displayed to allow the user to select the desired data set file.

Return Value:

Zero for success; non-zero for failure.

Public Function SaveDataSet( _
Optional ByVal fileExt As String = "..." _
) As Integer

Description:

Save the current data set.

Parameters:

fileExt

File extension to append to the data set name. If none is specified (or default "..."), no file extension will be appended.

Return Value:

Zero for success; non-zero for failure.

Public Sub ResetDataSet()

Description:

Reset the current data set.

Public Function DeleteDataSet( _
Optional ByVal dsName As String = "" _
) As Integer

Description:

Delete the specified data set.

Parameters:

dsName

Name of the data set to delete.  If none is specified the current data set is deleted.

Return Value:

Zero for success; non-zero for failure.

The remaining public methods are intended solely for use by the other TSENTRY objects.

The following events are exposed by the TPRI.DataSetInfo object.

Public Event OnNew( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

Indicates a new data set has been created.

Parameters:

Sender

The source of the event.

e

Event argument.

Public Event OnLoad( _
ByVal Sender As System.Object, _
ByVal tmpName As String _
)

Description:

Indicates that a data set has been loaded.

Parameters:

Sender

The source of the event.

tmpName

Name of the loaded data set.

Public Event OnSave( _
ByVal Sender As System.Object, _
ByVal tmpName As String _
)

Description:

Triggered when the control is clicked.

Parameters:

Sender

The source of the event.

tmpName

Name of the saved data set.

The TPRI.DDVarSelect object is used to select a variable from the data dictionary and display its name to the user.

[PICTURE]

The TPRI.DDVarSelect object acts as a simple text entry to allow the user to type in a valid variable name from the data dictionary.  Alternatively, the user may click on the '*' button in the upper right-hand corner of the text box to bring up the Data Dictionary browser [LINK] .  Once the user selects a value from the data dictionary browser, it is automatically loaded into the text box of the TPRI.DDVarSelect object.

Use of the TPRI.DDVarSelect object requires that a separate TPRI.DataDict object exist elsewhere on the screen.  Typically a TPRI.DataDict object is dropped in an unused portion of the screen and made invisible so that the object itself is not displayed on the form.  Only one TPRI.DataDict object is required to service all of the TPRI.DDVarSelect objects on a screen.

The following properties are exposed by the TPRI.DDVarSelect class.

[TABLE]

There are no public methods exposed by the TPRI.DDVarSelect class.

The following events are exposed by the TPRI.DDVarSelect class.

Public Event VarNameUpdate( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

Indicates the variable name has been updated.

Parameters:

Sender

The source of the event.

e

Event argument.

The TPRI.DataDict object is used to access the data dictionary on the controller.

[PICTURE]

Normally, a TPRI.DataDict object on a user screen is configured as invisible so that it is hidden from the user.  The variable selection form itself is accessed by calling the DoModal(..) function. This form allows the user to graphically navigate through the data dictionary to choose a variable from global common.

Image Added

The top left of this form contains the Global Common Structure Tree.  The root elements in this tree represent each of the available global common, and expanding one of these commons reveals its internal structure.  Single clicking on variable name highlights the variable, while double clicking automatically selects the variable and closes the form.

To the right of the Global Common Structure Tree is the Selected Variable information box.  Once highlighted in the structure tree, the full structure name, element type, and description of the selected variable are displayed.

Below the Selected Variable information box is the Return selection box.  The main edit box here displays the variable name string as it will be returned to the screen.  Normally, this string consists of the fully qualified variable name; however, instead of returning a string representing the variable itself, the user has the option to instead return a string representing some property of the variable.  The following options are available:

The bottom half of the variable selection form allows the user to search through variable names and descriptions for strings.  Typing in the selection string and hitting the enter key activates the search, which fills the list box below with all matching variables.  Single clicking on a found variable locates it in the structure tree and displays its information in the Selected Variable box.  Double clicking on the variable name automatically selects it and closes the variable selection form.  

Tip: The user can search the data dictionary for multiple strings by separating them with spaces in the Search string.  In this case all of the specified words must exist in either the variable name or description in order for the variable to be displayed.

The data dictionary display is initialized by copies of the structure and variable data dictionary initialization files used to initialize the data dictionary for the processes on the control system.  The TPRI.DataDict object looks for these copies hosted on the web server at the locations specified by the VarsFileName and StructFileName properties of the object.  Normally, these copies are made as part of the data dictionary building process on the host.

For more in-depth information about the data dictionary, refer to Data Dictionary [LINK].

The following properties are exposed by the TPRI.DataDict class.

[TABLE]

The following public methods are exposed by the TPRI.DataDict object.

Public Function StartComm( _
ByVal sHostName As String, _
ByVal sPathDir As String _
) As Integer

Description:

Start communications with a host.

Parameters:

sHostName

Name or IP address of the data host.

sPathDir

Path/subdirectory of page on host.

Return Value:

Zero for success; non-zero for failure.

Public Function DoModal( _
ByVal defVarName As String _
) As Integer

Description:

Display the data dictionary browser form.

Parameters:

defVarName

Default variable name to highlight.

Return Value:

Zero for success; non-zero for failure.

Public Function GetVarName() As String

Description:

Get the selected variable name.

Return Value:

Selected variable name.

public: int GetFiles( _
tpriIniFile** pStructIni,
tpriIniFile** pVarsIni,
Boolean bForceRefresh
);

Description:

Create new tpriIniFile objects containing the structure and variable definition files.  This method is only callable from a C++.NET object due to the requirement of the tpriIniFile class definitions.

Parameters:

pStructIni

Address of pointer to assign to new tpriIniFile object containing structure.  If successfully assigned this object must be explicitly deleted; it is not managed by the garbage collector.

pVarsIni

Address of pointer to assign to new tpriIniFile object containing structure.  If successfully assigned this object must be explicitly deleted; it is not managed by the garbage collector.

bForceRefresh

Flag to refresh the files from the host or simply return the latest data.

Return Value:

Zero for success; non-zero for failure.

There are no events exposed by the TPRI.DataDict object.

The TPRI.HMI.Controls.TrendCtrl object is used to select variables for trending as well as to monitor the values of each of these variables during trending.  The main display of the TrendCtrl object is a grid of information displaying information about the entire set of trended variables.  

[PICTURE]

At run-time, the TrendCtrl itself is used mainly as a display to provide feedback about the data being trended.  The top two rows of the TrendCtrl object display the dates and times for trended data.  The remaining rows are broken up by axis, with the trended variables shown for each axis.

The information displayed for each variable, in columns from left to right, are:

• The color of the pen used to trend the variable.  For instance, the PidCom.rtDrift.filtDrift variable above is being plotted in yellow.

• The label associated with the variable.  Each variable can have an associated label for a sensible description of what is being trended.  If no label is specified this column will instead display the actual name of the variable.

• Value of the variable at the left cursor.  The value displayed in the first data column (magenta background) is the value of the variable underneath the magenta cursor bar.  If cursors are not being used, this value represents the value of the data at the leftmost edge of the trend graph.  For instance, the left cursor data value for the PidCom.rtDrift.filtDrift variable above is 2.1895e-5.

• Value of the variable at the right cursor.  The value displayed in the second data column (cyan background) is the value of the variable underneath the cyan cursor bar.  If cursors are not being used, this value represents the value of the data at the rightmost edge of the trend graph.  For instance, the left cursor data value for the PidCom.rtDrift.filtDrift variable above is 3.3646e-4.

• Difference in values between the left and right cursors.  The value displayed in the third data column (gray background) is equal to the left cursor value minus the right cursor value, useful for easily determining how much a value has changed during some period of time.  For instance, the difference in cursor data values for the PidCom.rtDrift.filtDrift variable above is (2.1895e-5 - 3.3646e-4) = -3.1457e-4.

Trends are configured via the Trend Setup form.  This form can be accessed at design-time via the TrendInfo property of the TrendCtrl object or at run-time by calling the TrendSetup() method of the TrendCtrl object.

Image Added

In the top portion of the form, the user can set various parameters to define the trend graph as a whole:

• Trend Width: width of the trend graph in seconds, that is, the total amount of time to be displayed on the trend graph.

• Sampling Period: sampling period for plotted points on the graph, as well as the requested sampling period for trended variables.  The total number of points plotted will equal the Trend Width divided by the Sampling Period.

• Default Source: trend source to which all trend variables should be assigned when the Set All Variables button is pressed.  This is useful when switching between two historical trend files created from the same trigger.

The middle 'Trend Axes' section of the form allows the user to add, delete, and configure each of the trend axes.  Several columns are provided to configure each axis:

1. The axis label is a descriptive string that will be attached to the axis on the trend graph.

2. Min specifies the minimum value of the vertical range for this axis.

3. Max specifies the maximum value of the vertical range for this axis.

4. The axis percentage specifies what percentage of the vertical extent of the entire trend graph should be used by this particular axis.  If the Normalize Axis Percentages option is selected (see below), these percentages will be automatically calculated and each axis will be given an equal amount.  If the Normalize Axis Percentages option is disabled, the user can individually configure each axis; however, the total percentage used by all activated axes must equal 100%.

The parameters for a given axis can be modified in one of two methods.  First, the user can highlight the desired axis and single-left-click on the parameter to be modified; within a few moments the field will become editable and the user can make the appropriate selection.  Alternatively, once highlighting the desired axis the user can right click anywhere on the axis entry to display a popup menu of options.  This menu contains several commands to edit the various axis properties.

Image Added

This popup menu also presents commands to insert and delete an axis and to enable or disable the Normalize Axis Percentages option mentioned above.

The bottom ‘Trend Variables’ section of the form allows the user to configure each individual variable for trending.  Variables are divided up according to the axis with which they are associated.  Several columns are provided to configure each variable:

1. The Source specifies the trend source which is responsible for providing the data for the given variable.

2. The Variable specifies the name of the variable within the trend source.

3. The Label is a descriptive string associated with the trend variable.  If set, this label is displayed on the TrendCtrl object instead of the actual variable name.

4. The Color specifies the pen color to be used when plotting this trend variable.

5. The Line Type specifies the how the trend should be plotted.  Available options include a variety of thin, medium, and thick pens drawing a solid, dashed, or dotted line.

Like the trend axis parameter, the parameters for a given trend variable can be modified in one of two methods.  First, the user can highlight the desired variable and single-left-click on the parameter to be modified; within a few moments the field will become editable and the user can make the appropriate selection.  Alternatively, once highlighting the desired axis the user can right click anywhere on the variable entry to display a popup menu of options.  This menu contains several commands to edit the various variable properties.

Image Added

This popup menu also presents commands to insert, delete, copy, and paste a variable or group of variables.

When editing the Source for a given variable, the user may either simply type in the appropriate source or alternatively click on the asterisk (*) to bring up the Select Trend Source dialog.  This dialog allows the user to select from the available trend sources.  It is described in detail in the TrendSrcSelect [LINK] section of this manual.

Similarly, when editing the Variable name for a given variable, the user may either simply type in the appropriate name or alternatively click on the asterisk (*) to bring up the Data Dictionary [LINK] dialog.  This dialog allows the user to browse through the available data dictionaries to find the appropriate variable in the desired source.  It is described in detail in the Data Dictionary section of this manual.  Note that if the data dictionary is used to select a variable, and a variable is chosen from a data dictionary that is different from the currently selected trend source, the trend source for the current variable will be updated to the new source accordingly.

Finally, there are several buttons in the lower right corner of the Trend Setup form.

• ‘OK’ accepts all changes and closes the Trend Setup form.

• ‘Cancel’ exits the Trend Setup form without saving the changes.

[TABLE]

The following properties are exposed by the TPRI.HMI.Controls.TrendCtrl class.The following public methods are exposed by the TPRI.TrendCtrl class for use by code on custom screens.

Public Sub TrendSetup()

Description:

Load and display the Trend Setup form.

The remaining public methods are intended solely for use by the other TSENTRY objects.

The following events are exposed by the TPRI.TrendCtrl class.

Public Event OnTrendClear( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

The trend control has been cleared and reset.

Parameters:

Sender

The source of the event.

e

Event argument.

Public Event OnTrendInit( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

The trend control has been initialized.

Parameters:

Sender

The source of the event.

e

Event argument.

Public Event OnChangedTrendSet( _
ByVal Sender As System.Object, _
ByVal e As System.EventArgs _
)

Description:

The set of trended variables has been changed.

Parameters:

Sender

The source of the event.

e

Event argument.

Public Event OnUpdData( _
ByVal Sender As System.Object, _
ByVal timeLast As Double, _
ByVal timestamps As String, _
ByVal values() As Single, _
ByVal cnt As Integer, _
ByVal forward As Boolean _
)

Description:

The trend control has updated data to the graph.

Parameters:

Sender

The source of the event.

timeLast

Timestamp associated with the most recent data point.

timestamps

String of timestamps for each data point.

values()

Array of data point values.

cnt

Number of data points.

forward

Indicates whether or not the above data is ordered forward in time or backward in time.