What is a Structure?

A Structure is a user defined data type. Structures are used in Interface Methods to represent data types that are compatible with Historian and allow the custom collectors to interact with Historian.

Note: The abbreviation, TK stands for Toolkit.

For developing basic Custom Collectors, you should have knowledge about the following structures:

  • ihInterfaceTKPreCfgInfo, ihInterfaceTKCfgInfo - Maintains collector configuration information.
  • ihCollectorToolKitDefProperties - Maintains collectors specific properties.
  • ihInterfaceTKDataInfo - Maintains data information.
  • ihInterfaceTKRecordset - Maintains tag recordset.
  • ihTKTagProperties - Maintains tag properties.
  • ihTKTagFields - Maintains tag fields details
  • ihTKTagCriteria - Maintains tag criteria details.
  • ihTKDataType - Maintains tag data type
  • ihInterfaceTKHierarchicalBrowseResponse - Maintains hierarchical browse response information.
  • ihInterfaceTKASyncTagInfo - Maintains Unsolicited tag information.
  • ihInterfaceTKPolledTagInfo - Maintains Polled tag information.

The following are few more structures that are used for developing Custom Collectors:

  • ihTKTagRecordset
  • ihTKBlobData
  • ihTKHiddenValue
  • ihTKRawQuality
  • ihTKQuality
  • ihTKCommentData
  • ihTKComments
  • ihTKDataProperties
  • ihInterfaceTKASyncData
  • ihTKGetDataType
  • ihTKStatus
  • ihTKMessageTopic
  • ihTKCollectorCallbacks
  • ihTKTimeStruct
  • ihTKQualityStatus
  • ihTKQualitySubStatus
  • ihTKDataType
  • ihTKInterfaceType
  • ihTKCollectionType
  • ihTKTimeStampType
  • ihTKTimeResolution
  • ihTKTagId
  • ihTKConditionCollectionComparison
  • ihTKAlarmInterfaceProperties
  • ihTKHierarchicalBrowseResponse