/// <summary>
/// Build an array of the watch variable records contained within the <c>WATCHVARIABLES</c> table of the data dictionary. This array is used to access the
/// parameters associated with the watch variables defined in the table. The array element is mapped to the old identifier field of the table.
/// </summary>
/// <param name="variableDataTable">Reference to the <c>WATCHVARIABLES</c> table of the data dictionary.</param>
/// <returns>>An array of the records contained within the <c>WATCHVARIABLES</c> table of the data dictionary, if the specified table is valid; otherwise, null.</returns>
protected override WatchVariable[] BuildDataTable(DataDictionary.WATCHVARIABLESDataTable variableDataTable)
{
// Local copy of the table.
WatchVariable[] variables;
if (variableDataTable == null)
{
return(null);
}
try
{
// Determine the maximum value of the identifier field in the WatchVariables table, it cannot be assumed that the table is sorted by WatchID value.
int iDMax = 0;
int iDCurrent = 0;
for (int record = 0; record < variableDataTable.Count; record++)
{
iDCurrent = variableDataTable[record].OLDID;
if (iDCurrent > iDMax)
{
iDMax = iDCurrent;
}
}
m_IdentifierMax = iDMax;
// Instantiate the lookup array.
variables = new WatchVariable[iDMax + 1];
// Populate the lookup table;
int identifier;
DataDictionary.WATCHVARIABLESRow row;
for (int record = 0; record < variableDataTable.Count; record++)
{
row = variableDataTable[record];
identifier = row.OLDID;
// Instantiate a new structure to contain the variable data and copy the data across.
WatchVariable watchVariable = new WatchVariable() as WatchVariable;
watchVariable.Identifier = row.WATCHID;
watchVariable.OldIdentifier = row.OLDID;
watchVariable.Name = row.VARIABLENAME;
watchVariable.FormatString = row.FORMATSTRING;
watchVariable.EmbeddedName = row.EMBEDDEDVARNAME;
watchVariable.DataType = (DataType_e)row.TYPEID;
watchVariable.ScaleFactor = row.SCALEFACTOR;
watchVariable.EnumBitIdentifier = row.ENUMBITID;
watchVariable.IsBitMask = (row.BITMASK == 0) ? true : false;
watchVariable.Units = row.UNITS;
watchVariable.MinChartScale = row.MINCHARTSCALE;
watchVariable.MaxChartScale = row.MAXCHARTSCALE;
watchVariable.AttributeFlags = row.FLAGS;
watchVariable.HelpIndex = row.HELPINDEX;
watchVariable.MinModifyValue = row.MINMODIFYVALUE;
watchVariable.MaxModifyValue = row.MAXMODIFYVALUE;
// Determine the variable type.
if (watchVariable.IsBitMask)
{
watchVariable.VariableType = VariableType.Bitmask;
}
else
{
if (watchVariable.EnumBitIdentifier == 0)
{
watchVariable.VariableType = VariableType.Scalar;
}
else
{
watchVariable.VariableType = VariableType.Enumerator;
}
}
// Add the structure to the correct element of the array.
variables[identifier] = watchVariable;
}
}
catch (Exception)
{
return(null);
}
return(variables);
}
/// <summary>
/// Initialize a new instance of the class.
/// </summary>
/// <param name="watchVariableDataTable">Reference to the <c>WATCHVARIABLES</c> table of the data dictionary.</param>
/// <param name="enumBitDataTable">Reference to the <c>WATCHENUMBIT</c> table of the data dictionary i.e. the enumerator/bitmask data table associated with
/// watch variables.</param>
public WatchVariableTableByOldIdentifier(DataDictionary.WATCHVARIABLESDataTable watchVariableDataTable, DataDictionary.WATCHENUMBITDataTable enumBitDataTable)
: base(watchVariableDataTable, enumBitDataTable)
{
}
