GetHdStoreSchema()

Returns the schema of the data for the specified HD store. It is possible to sort the schema according to modules or logical groups. Schemas of event-based stores are always returned in a logical group structure (folders).

Message "GetHdStoreSchemaRequest"

Structure

To copy the code to the clipboard click on the icon ->

GetHdStoreSchemaRequest{
}

Parameter

Pos.	Parameter	Data type	Meaning
1	hd_store_name	string	Name of the store as contained in the response of GetHdStores(), see GetHdStores().
2	sort_by	enum(SortByType)	Determines whether the channels are to be returned sorted by modules or logical groups, see Enum"SortByType".
3	info_fields	bool	If True, optional info fields for time or event channels are requested.

Message "GetHdStoreSchemaRequest"

Structure

To copy the code to the clipboard click on the icon ->

GetHdStoreSchemaResponse{
   ChannelGroup{
      ChannelDefinition{…}
      EventDefinition {…}
      ChannelGroup{…}
   }
}

Parameter

Contains modules or the root of the logical groups, depending on the setting selected in the sort_by parameter. A ChannelGroup message with the following parameters is returned for each module or group.

Pos.	Parameter	Data type	Meaning
1	name	string	Name of the module or logical group
2	group_type	enum(GroupType)	Visualization type of the group or module, see Enum"GroupType".
3	channels	-	Returns the message ChannelDefinition for channels from time-based stores per channel, see Message "ChannelDefinition". Empty for other store types.
4	events	-	Returns the message EventDefinition for channels from event-based stores per channel, see Message "EventDefinition". Empty for other store types.
5	channel_groups	-	Returns a Message ChannelGroup for each group that is nested within this group (tree hierarchy).
6	group_number	int32	ID of the group Is used, if group_type = GROUP_TYPE_MODULE, GROUP_TYPE_GROUP or GROUP_TYPE_FOLDER

Message "ChannelDefinition"

The Message ChannelDefinition contains the following parameters.

Pos.	Parameter	Data type	Meaning
1	channel_id	string	Fully qualified ID in the format `<HD store name>\<channel id>` Example: `store_1\[0:0]`
2	name	string	Name of the channel
3	active	bool	Indication of whether the channel is currently being recorded
4	data_type	enum(DataType)	Data type that is sent when data is requested from this channel, see Enum "DataType".
5	unit	string	User-defined unit for the channel
6	comment_1	string	User-defined comment
7	comment_2	string	User-defined comment
8	info_fields	-	Optional list of the channel's info fields, see Message "InfoField". Empty by default if not requested
9	channel_number	int32	Signal number (part of channel_id).

Message "EventDefinition"

The Message EventDefinition contains the following parameters.

Pos.	Parameter	Data type	Meaning
1	channel_id	string	Fully qualified ID in the format `<HD store name>\<event channel id>` Example: `store_1\[0]`
2	name	string	Name of the event
3	active	bool	Indication of whether the channel is currently being recorded
4	event_type	enum(EventType)	Type of event, see Enum"EventType".
5	comment_1	string	User-defined comment
6	comment_2	string	User-defined comment
7	priority	string	User-defined priority
8	numeric_fields	-	Definition of the numerical fields that are to be captured when the event is recorded, see Message "FieldDefinition".
9	text_fields	-	Definition of the text fields that are to be captured when the event is recorded, see Message "FieldDefinition".
10	info_fields	-	Optional list of the event's info fields, see Message "InfoField". Empty by default if not requested

Message "InfoField"

The Message InfoField contains the following parameters.

Pos.	Parameter	Data type	Meaning
1	key	string	Key of the info field
2	values	string	List of the info field values

Message "FieldDefinition"

The Message FieldField contains the following parameters.

Pos.	Parameter	Data type	Meaning
1	name	string	Name of the field

Enum"SortByType"

The following values are available for the SortByType.

Value		Meaning
0	SORT_BY_UNSPECIFIED	Not specified
1	SORT_BY_MODULE	Sorted by modules
2	SORT_BY_LOGICAL_GROUP	Sorted by logical groups

Enum"GroupType"

Visualization type of the group or module. The following values are available for the GroupType.

Value		Meaning
0	GROUP_TYPE_UNSPECIFIED	Not specified
1	GROUP_TYPE_HDSTORE_TIME	Time-based store
2	GROUP_TYPE_HDSTORE_EVENT	Event-based store
3	GROUP_TYPE_HDSTORE_ALARM_EVENT	Alarms & Events store
4	GROUP_TYPE_DIAGNOSTIC	Diagnostic store
10	GROUP_TYPE_ANNOTATIONS	Not in use
11	GROUP_TYPE_ANNOTATIONS	Module that contains annotations
12	GROUP_TYPE_MODULE	Modules
13	GROUP_TYPE_VECTOR2D	Vectors
14	GROUP_TYPE_FOLDER	Module folder
15	GROUP_TYPE_LOCATION	Measurement location of a lengthbased HD store
16	GROUP_TYPE_EVENTFLOAT	Not in use
17	GROUP_TYPE_EVENTTEXT	Not in use
18	GROUP_TYPE_GROUP	Signal group
19	GROUP_TYPE_BACKUP	Not in use
22	GROUP_TYPE_BACKUPSTART	Not in use
23	GROUP_TYPE_BACKUPSTOP	Not in use
24	GROUP_TYPE_DATFILE	Not in use
25	GROUP_TYPE_INFOHEADER	Not in use
26	GROUP_TYPE_INFOFIELD	Not in use
27	GROUP_TYPE_ASTERISK	Not in use
28	GROUP_TYPE_DISABLED	Not in use

Enum "DataType"

The following values are available for DataType.

Value		Meaning
0	DATA_TYPE_UNSPECIFIED	Not specified
1	DATA_TYPE_FLOAT_VALUES	Value of type "float"
2	DATA_TYPE_DOUBLE_VALUES	Value of type "double"
3	DATA_TYPE_STRING_VALUES	Value of type "string"
4	DATA_TYPE_DIGITAL_VALUES	Digital value
5	DATA_TYPE_NE_FLOAT_VALUES	Value of type “float” that was stored non-equidistantly
6	DATA_TYPE_NE_DOUBLE_VALUES	Digital value that was stored non-equidistantly
7	DATA_TYPE_DIGITAL_EDGE_VALUES	Number of changes of a digital non-equidistant value

Enum"EventType"

The following values are available for the EventType parameter.

Value		Meaning
0	EVENT_TYPE_UNSPECIFIED	Not specified
1	EVENT_TYPE_GENERAL_EVENT	General event
2	EVENT_TYPE_ANNOTATION	Event of type "annotation"
3	EVENT_TYPE_ALARM	Event of type "alerm"