GetHdStoreSchema()

Gibt das Schema der Daten für die angegebene HD-Ablage zurück. Es ist möglich, das Schema nach Modulen oder logischen Gruppen zu sortieren. Schemata ereignisbasierter Ablagen werden immer in einer logischen Gruppenstruktur (Ordnern) zurückgegeben.

Message "GetHdStoreSchemaRequest"

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken ->

GetHdStoreSchemaRequest{
}

Parameter

Pos.	Parameter	Datentyp	Bedeutung
1	hd_store_name	string	Name der Ablage, wie er in der Response von GetHdStores() enthalten ist, siehe GetHdStores().
2	sort_by	enum(SortByType)	Legt fest, ob die Kanäle nach Modulen oder logischen Gruppen sortiert zurückgegeben werden sollen, siehe Enum "SortByType".
3	info_fields	bool	Wenn True, dann werden optionale Infofelder für Zeit- oder Ereigniskanäle angefordert.

Message "GetHdStoreSchemaResponse"

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken ->

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

Parameter

Enthält, abhängig von der gewählten Einstellung im Parameter sort_by, Module oder die Wurzel der logischen Gruppen. Pro Modul bzw. Gruppe wird eine Message ChannelGroup mit folgenden Parametern zurückgegeben.

Pos.	Parameter	Datentyp	Bedeutung
1	name	string	Name des Moduls oder der logischen Gruppe
2	group_type	enum(GroupType)	Visualisierungsart der Gruppe oder des Moduls, siehe Enum "GroupType".
3	channels	-	Gibt für Kanäle aus zeitbasierten Ablagen je Kanal die Message ChannelDefinition zurück, siehe Message "ChannelDefinition". Für andere Ablagentypen leer.
4	events	-	Gibt für Kanäle aus ereignisbasierten Ablagen je Kanal die Message EventDefinition zurück, siehe Message "EventDefinition". Für andere Ablagentypen leer.
5	channel_groups	-	Gibt für Gruppen, die innerhalb dieser Gruppe verschachtelt sind, je eine Message ChannelGroup zurück (Baumhierarchie).
6	group_number	int32	ID der Gruppe Wird verwendet, wenn group_type = GROUP_TYPE_MODULE, GROUP_TYPE_GROUP oder GROUP_TYPE_FOLDER

Message "ChannelDefinition"

Die Message ChannelDefinition enthält folgende Parameter.

Pos.	Parameter	Datentyp	Bedeutung
1	channel_id	string	Vollständig qualifizierte ID im Format `<HD store name>\<channel id>` Beispiel: `store_1\[0:0]`
2	name	string	Name des Kanals
3	active	bool	Angabe, ob der Kanal aktuell aufgezeichnet wird
4	data_type	enum(DataType)	Datentyp, der gesendet wird, wenn Daten von diesem Kanal angefordert werden, siehe Enum "DataType".
5	unit	string	Benutzerdefinierte Einheit für den Kanal
6	comment_1	string	Benutzerdefinierter Kommentar
7	comment_2	string	Benutzerdefinierter Kommentar
8	info_fields	-	Optionale Liste der Infofelder des Kanals, siehe Message "InfoField". Standardmäßig leer, wenn nicht angefordert
9	channel_number	int32	Signalnummer (Teil der channel_id).

Message "EventDefinition"

Die Message EventDefinition enthält folgende Parameter.

Pos.	Parameter	Datentyp	Bedeutung
1	channel_id	string	Vollständig qualifizierte ID im Format `<HD store name>\<event channel id>` Beispiel: `store_1\[0]`
2	name	string	Name des Ereignisses
3	active	bool	Angabe, ob der Kanal aktuell aufgezeichnet wird
4	event_type	enum(EventType)	Art des Ereignisses, siehe Enum "EventType".
5	comment_1	string	Benutzerdefinierter Kommentar
6	comment_2	string	Benutzerdefinierter Kommentar
7	priority	string	Benutzerdefinierte Priorität
8	numeric_fields	-	Definition der numerischen Felder, die bei der Aufzeichnung des Ereignisses erfasst werden sollen, siehe Message "FieldDefinition".
9	text_fields	-	Definition der Textfelder, die bei der Aufzeichnung des Ereignisses erfasst werden sollen, siehe Message "FieldDefinition".
10	info_fields	-	Optionale Liste der Infofelder des Ereignisses, siehe Message "InfoField". Standardmäßig leer, wenn nicht angefordert

Message "InfoField"

Die Message InfoField enthält folgende Parameter.

Pos.	Parameter	Datentyp	Bedeutung
1	key	string	Schlüssel des Infofelds
2	values	string	Liste der Infofeldwerte

Message "FieldDefinition"

Die Message FieldDefinition enthält folgende Parameter.

Pos.	Parameter	Datentyp	Bedeutung
1	name	string	Name des Feldes

Enum "SortByType"

Folgende Werte stehen für SortByType zur Verfügung.

Wert		Bedeutung
0	SORT_BY_UNSPECIFIED	nicht spezifiziert
1	SORT_BY_MODULE	Sortiert nach Modulen
2	SORT_BY_LOGICAL_GROUP	Sortiert nach logischen Gruppen

Enum "GroupType"

Visualisierungsart der Gruppe oder des Moduls. Folgende Werte stehen für GroupType zur Verfügung.

Wert		Bedeutung
0	GROUP_TYPE_UNSPECIFIED	nicht spezifiziert
1	GROUP_TYPE_HDSTORE_TIME	Zeitbasierte HD-Ablage
2	GROUP_TYPE_HDSTORE_EVENT	Ereignisbasierte HD-Ablage
3	GROUP_TYPE_HDSTORE_ALARM_EVENT	Alarms & Events-Ablage
4	GROUP_TYPE_DIAGNOSTIC	Diagnoseablage
10	GROUP_TYPE_ANNOTATIONS	nicht genutzt
11	GROUP_TYPE_ANNOTATION	Modul, das Vermerke enthält
12	GROUP_TYPE_MODULE	Module
13	GROUP_TYPE_VECTOR2D	Vektoren
14	GROUP_TYPE_FOLDER	Modulordner
15	GROUP_TYPE_LOCATION	Messort einer längenbasierten HD-Ablage
16	GROUP_TYPE_EVENTFLOAT	nicht genutzt
17	GROUP_TYPE_EVENTTEXT	nicht genutzt
18	GROUP_TYPE_GROUP	Signalgruppe
19	GROUP_TYPE_BACKUP	nicht genutzt
22	GROUP_TYPE_BACKUPSTART	nicht genutzt
23	GROUP_TYPE_BACKUPSTOP	nicht genutzt
24	GROUP_TYPE_DATFILE	nicht genutzt
25	GROUP_TYPE_INFOHEADER	nicht genutzt
26	GROUP_TYPE_INFOFIELD	nicht genutzt
27	GROUP_TYPE_ASTERISK	nicht genutzt
28	GROUP_TYPE_DISABLED	nicht genutzt

Enum "DataType"

Folgende Werte stehen für DataType zur Verfügung.

Wert		Bedeutung
0	DATA_TYPE_UNSPECIFIED	nicht spezifiziert
1	DATA_TYPE_FLOAT_VALUES	Wert vom Typ "float"
2	DATA_TYPE_DOUBLE_VALUES	Wert vom Typ "double"
3	DATA_TYPE_STRING_VALUES	Wert vom Typ "string"
4	DATA_TYPE_DIGITAL_VALUES	Digitaler Wert
5	DATA_TYPE_NE_FLOAT_VALUES	Wert vom Typ "float", der nicht-äquidistant gespeichert wurde
6	DATA_TYPE_NE_DOUBLE_VALUES	Digitaler Wert, det nicht-äquidistant gespeichert wurde
7	DATA_TYPE_DIGITAL_EDGE_VALUES	Anzahl der Wechsel eines digitalen nicht-äquidistanten Werts

Enum "EventType"

Folgende Werte stehen für den Parameter EventType zur Verfügung.

Wert		Bedeutung
0	EVENT_TYPE_UNSPECIFIED	nicht spezifiziert
1	EVENT_TYPE_GENERAL_EVENT	Allgemeines Ereignis
2	EVENT_TYPE_ANNOTATION	Ereignis vom Typ "Anmerkung"
3	EVENT_TYPE_ALARM	Ereignis vom Typ "Alarm"