Data types module header file. More...

#include "string_type.h"

Include dependency graph for data_types.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	item_meta_details_t
	This struct is used for building item.meta.details structure. More...

struct	item_meta_payload_details_time_series_t
	This struct is used for the time_series.meta.payload.details structure. More...

struct	item_meta_payload_details_file_t
	This struct is used for building file.meta.payload.details structure. More...

struct	item_meta_payload_details_custom_t
	This struct is used for building custom.meta.payload.details structure. More...

union	item_meta_payload_details_union_t
	This union is used for building item.meta.payload.details for time series, file and custom data. More...

struct	item_meta_payload_t
	This struct is used for building item.meta.payload structure. More...

struct	item_meta_t
	This struct is used for building item.meta structure. More...

struct	time_series_value_t
	This struct is used for building time_series.payload.values structure. More...

struct	time_series_value_set_t
	This struct is used for building value set of time series. More...

struct	time_series_payload_t
	This struct is used for building the payload of time series which is list of value sets. More...

struct	event_payload_t
	This struct is used for building event.payload structure. More...

struct	file_payload_t
	This struct is used for building file.payload structure. More...

struct	binary_payload_t
	This struct is used for building custom_data.payload structure. More...

struct	data_point_t
	This struct is used for building data_source_configuration.data_points structure. More...

struct	data_source_t
	This struct is used for building data_source_configuration.data_source structure. More...

struct	data_source_configuration_payload_t
	This struct is used for building data_source_configuratio.payload structure. More...

Typedefs
typedef struct mcl_time_series_t	time_series_t

typedef struct mcl_json_t	mcl_json_t

Enumerations
enum	E_META_FIELD_NAMES { META_FIELD_TYPE, META_FIELD_VERSION, META_FIELD_PAYLOAD_META, META_FIELD_PAYLOAD, META_FIELD_PAYLOAD_TYPE, META_FIELD_PAYLOAD_VERSION, META_FIELD_PAYLOAD_DETAILS, META_FIELD_PAYLOAD_DETAILS_CONFIGURATION_ID, META_FIELD_DETAILS, META_FIELD_DETAILS_ROUTING, META_FIELD_PAYLOAD_DETAILS_FILE_NAME, META_FIELD_PAYLOAD_DETAILS_FILE_TYPE, META_FIELD_PAYLOAD_DETAILS_CREATION_DATE, META_FIELD_DETAILS_TOTAL_ITEMS, META_FIELD_PAYLOAD_DETAILS_TIMESTAMP, META_FIELD_PAYLOAD_DETAILS_DURATION, META_FIELD_NAMES_END }
	Used with meta_field_names[E_META_FIELD_NAMES] to get the related string. ex: meta_field_names[META_FIELD_TYPE] returns the string of "type". More...

enum	E_PAYLOAD_FIELD_NAMES { PAYLOAD_FIELD_TIMESTAMP, PAYLOAD_FIELD_VALUES, PAYLOAD_FIELD_VALUES_DATA_POINT_ID, PAYLOAD_FIELD_VALUES_VALUE, PAYLOAD_FIELD_VALUES_QUALITY_CODE, PAYLOAD_FIELD_ID, PAYLOAD_FIELD_CUSTOM_EVENT_ID, PAYLOAD_FIELD_CORRELATION_ID, PAYLOAD_FIELD_SOURCE_TYPE, PAYLOAD_FIELD_SOURCE_ID, PAYLOAD_FIELD_SEVERITY, PAYLOAD_FIELD_DESCRIPTION, PAYLOAD_FIELD_STATUS, PAYLOAD_FIELD_TYPE, PAYLOAD_FIELD_VERSION, PAYLOAD_FIELD_CUSTOM_DATA, PAYLOAD_FIELD_DETAILS, PAYLOAD_FIELD_DETAILS_MESSAGE, PAYLOAD_FIELD_DETAILS_ERROR_CODE, PAYLOAD_FIELD_DETAILS_DETAILS, PAYLOAD_FIELD_DETAILS_VALUE, PAYLOAD_FIELD_DETAILS_DOWNLOAD_LINK, PAYLOAD_FIELD_DETAILS_NAME, PAYLOAD_FIELD_DETAILS_VERSION, PAYLOAD_FIELD_DETAILS_DESCRIPTION, PAYLOAD_FIELD_CONFIGURATION_ID, PAYLOAD_FIELD_DATA_SOURCES, PAYLOAD_FIELD_DATA_SOURCES_NAME, PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS, PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_ID, PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_NAME, PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_TYPE, PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_UNIT, PAYLOAD_FIELD_NAMES_END }
	Used with payload_field_names[E_PAYLOAD_FIELD_NAMES] to get the related string. ex: payload_field_names[PAYLOAD_FIELD_TIMESTAMP] returns the string of "timeStamp". More...

enum	E_META_FIELD_VALUES { META_FIELD_TYPE_ITEM, META_FIELD_VERSION_CURRENT, META_FIELD_PAYLOAD_VERSION_CURRENT, META_FIELD_PAYLOAD_TYPE_TIME_SERIES, META_FIELD_PAYLOAD_TYPE_BUSINESS_EVENT, META_FIELD_PAYLOAD_TYPE_FILE, META_FIELD_PAYLOAD_TYPE_DATA_SOURCE_CONFIGURATION, META_FIELD_VALUES_END }
	Used with meta_field_values[E_META_FIELD_VALUES] to get the related string. ex: meta_field_values[META_FIELD_TYPE_ITEM] returns the string of "item". Please refer to the MindConnectAPI Specifications for detailed info. More...

enum	E_PAYLOAD_FIELD_VALUES { PAYLOAD_FIELD_SEVERITY_URGENT, PAYLOAD_FIELD_SEVERITY_IMPORTANT, PAYLOAD_FIELD_SEVERITY_INFORMATION, PAYLOAD_FIELD_SOURCE_TYPE_ASSET, PAYLOAD_FIELD_SOURCE_TYPE_AGENT, PAYLOAD_FIELD_SOURCE_TYPE_APPLICATION, PAYLOAD_FIELD_VALUES_END }
	Used with payload_field_values[E_PAYLOAD_FIELD_VALUES] to get the related string. ex: payload_field_values[PAYLOAD_FIELD_SEVERITY_URGENT] returns the string of "1". More...

enum	E_CONTENT_TYPE_VALUES { CONTENT_TYPE_APPLICATION_OCTET_STREAM, CONTENT_TYPE_TEXT_PLAIN, CONTENT_TYPE_APPLICATION_JSON, CONTENT_TYPE_MULTIPART_MIXED, CONTENT_TYPE_MULTIPART_RELATED, CONTENT_TYPE_META_JSON, CONTENT_TYPE_URL_ENCODED, TRANSFER_ENCODING_CHUNKED, CONTENT_TYPE_VALUES_END }
	Used with http_header_values[E_HTTP_HEADER_VALUES] to get the related string. ex: http_header_values[HTTP_HEADER_CONTENT_TYPE_APPLICATION_OCTET_STREAM] returns the string of "application/octet-stream". More...

Variables
string_t	meta_field_names [META_FIELD_NAMES_END]

string_t	meta_field_values [META_FIELD_VALUES_END]

string_t	payload_field_values [PAYLOAD_FIELD_VALUES_END]

string_t	payload_field_names [PAYLOAD_FIELD_NAMES_END]

string_t	content_type_values [CONTENT_TYPE_VALUES_END]

Detailed Description

Data types module header file.

Copyright: Copyright (C) 2016 Siemens Aktiengesellschaft.
All rights reserved.

Date: Jun 27, 2016 This module contains data type definitions.

Definition in file data_types.h.

Typedef Documentation

typedef struct mcl_json_t mcl_json_t

Definition at line 23 of file data_types.h.

typedef struct mcl_time_series_t time_series_t

Definition at line 21 of file data_types.h.

Enumeration Type Documentation

enum E_CONTENT_TYPE_VALUES

Used with http_header_values[E_HTTP_HEADER_VALUES] to get the related string. ex: http_header_values[HTTP_HEADER_CONTENT_TYPE_APPLICATION_OCTET_STREAM] returns the string of "application/octet-stream".

Enumerator
CONTENT_TYPE_APPLICATION_OCTET_STREAM	Content type is application octet stream.
CONTENT_TYPE_TEXT_PLAIN	Content type is text plain.
CONTENT_TYPE_APPLICATION_JSON	Content type is application json.
CONTENT_TYPE_MULTIPART_MIXED	Content type is multipart mixed.
CONTENT_TYPE_MULTIPART_RELATED	Content type is multipart related.
CONTENT_TYPE_META_JSON	Content type is meta json.
CONTENT_TYPE_URL_ENCODED	Content type is application/x-www-form-urlencoded.
TRANSFER_ENCODING_CHUNKED	Transfer encoding chunked.
CONTENT_TYPE_VALUES_END	End of content type values.

Definition at line 312 of file data_types.h.

enum E_META_FIELD_NAMES

Used with meta_field_names[E_META_FIELD_NAMES] to get the related string. ex: meta_field_names[META_FIELD_TYPE] returns the string of "type".

Enumerator
META_FIELD_TYPE	Type of meta field.
META_FIELD_VERSION	Version of meta field.
META_FIELD_PAYLOAD_META	Meta of meta field payload.
META_FIELD_PAYLOAD	Meta field payload.
META_FIELD_PAYLOAD_TYPE	Type of meta field payload.
META_FIELD_PAYLOAD_VERSION	Version of meta field payload.
META_FIELD_PAYLOAD_DETAILS	Meta field payload details.
META_FIELD_PAYLOAD_DETAILS_CONFIGURATION_ID	Configuration id of meta field payload details.
META_FIELD_DETAILS	Meta field details.
META_FIELD_DETAILS_ROUTING	Routing of meta field details.
META_FIELD_PAYLOAD_DETAILS_FILE_NAME	File name of meta field details.
META_FIELD_PAYLOAD_DETAILS_FILE_TYPE	File type of meta field details.
META_FIELD_PAYLOAD_DETAILS_CREATION_DATE	Creation date of meta field details.
META_FIELD_DETAILS_TOTAL_ITEMS	Total items of meta field details.
META_FIELD_PAYLOAD_DETAILS_TIMESTAMP	Timestamp of meta field payload details.
META_FIELD_PAYLOAD_DETAILS_DURATION	Duration of meta field payload details.
META_FIELD_NAMES_END	End of meta field names.

Definition at line 213 of file data_types.h.

enum E_META_FIELD_VALUES

Used with meta_field_values[E_META_FIELD_VALUES] to get the related string. ex: meta_field_values[META_FIELD_TYPE_ITEM] returns the string of "item". Please refer to the MindConnectAPI Specifications for detailed info.

Enumerator
META_FIELD_TYPE_ITEM	Item type of meta field.
META_FIELD_VERSION_CURRENT	Current version of meta field.
META_FIELD_PAYLOAD_VERSION_CURRENT	Current version of meta field payload.
META_FIELD_PAYLOAD_TYPE_TIME_SERIES	Time series type of meta field payload.
META_FIELD_PAYLOAD_TYPE_BUSINESS_EVENT	Business event type of meta field payload.
META_FIELD_PAYLOAD_TYPE_FILE	File type of meta field payload.
META_FIELD_PAYLOAD_TYPE_DATA_SOURCE_CONFIGURATION	Data source configuration type of meta field payload.
META_FIELD_VALUES_END	End of meta field values.

Definition at line 281 of file data_types.h.

enum E_PAYLOAD_FIELD_NAMES

Used with payload_field_names[E_PAYLOAD_FIELD_NAMES] to get the related string. ex: payload_field_names[PAYLOAD_FIELD_TIMESTAMP] returns the string of "timeStamp".

Enumerator
PAYLOAD_FIELD_TIMESTAMP	Timestamp of payload field.
PAYLOAD_FIELD_VALUES	Payload field values.
PAYLOAD_FIELD_VALUES_DATA_POINT_ID	Data point id of payload field values.
PAYLOAD_FIELD_VALUES_VALUE	Value of payload field values.
PAYLOAD_FIELD_VALUES_QUALITY_CODE	Quality code of payload field values.
PAYLOAD_FIELD_ID	Payload field id.
PAYLOAD_FIELD_CUSTOM_EVENT_ID	Custom event id of payload field.
PAYLOAD_FIELD_CORRELATION_ID	Correlation id of payload field.
PAYLOAD_FIELD_SOURCE_TYPE	Source type of payload field.
PAYLOAD_FIELD_SOURCE_ID	Source id of payload field.
PAYLOAD_FIELD_SEVERITY	Severity of payload field.
PAYLOAD_FIELD_DESCRIPTION	Description of payload field.
PAYLOAD_FIELD_STATUS	Status of payload field.
PAYLOAD_FIELD_TYPE	Type of payload field.
PAYLOAD_FIELD_VERSION	Version of payload field.
PAYLOAD_FIELD_CUSTOM_DATA	Custom data of payload field.
PAYLOAD_FIELD_DETAILS	Details of payload field.
PAYLOAD_FIELD_DETAILS_MESSAGE	Message of payload field details.
PAYLOAD_FIELD_DETAILS_ERROR_CODE	Error code of payload field details.
PAYLOAD_FIELD_DETAILS_DETAILS	Details of payload field details.
PAYLOAD_FIELD_DETAILS_VALUE	Value of payload field details.
PAYLOAD_FIELD_DETAILS_DOWNLOAD_LINK	Download link of payload field details.
PAYLOAD_FIELD_DETAILS_NAME	Name of payload field details.
PAYLOAD_FIELD_DETAILS_VERSION	Version of payload field details.
PAYLOAD_FIELD_DETAILS_DESCRIPTION	Description of payload field details.
PAYLOAD_FIELD_CONFIGURATION_ID	Configuration id of payload field.
PAYLOAD_FIELD_DATA_SOURCES	Payload field data sources.
PAYLOAD_FIELD_DATA_SOURCES_NAME	Name of payload field data sources.
PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS	Payload field data sources data points.
PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_ID	Data point id of payload field assets data sources data points.
PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_NAME	Name of payload field data sources data points.
PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_TYPE	Type of payload field data sources data points.
PAYLOAD_FIELD_DATA_SOURCES_DATA_POINTS_UNIT	Unit of payload field data sources data points.
PAYLOAD_FIELD_NAMES_END	End of payload field names.

Definition at line 238 of file data_types.h.

enum E_PAYLOAD_FIELD_VALUES

Used with payload_field_values[E_PAYLOAD_FIELD_VALUES] to get the related string. ex: payload_field_values[PAYLOAD_FIELD_SEVERITY_URGENT] returns the string of "1".

Enumerator
PAYLOAD_FIELD_SEVERITY_URGENT	Severity level of payload field is urgent.
PAYLOAD_FIELD_SEVERITY_IMPORTANT	Severity level of payload field is important.
PAYLOAD_FIELD_SEVERITY_INFORMATION	Severity level of payload field is information.
PAYLOAD_FIELD_SOURCE_TYPE_ASSET	Source type of payload is asset.
PAYLOAD_FIELD_SOURCE_TYPE_AGENT	Source type of payload is agent.
PAYLOAD_FIELD_SOURCE_TYPE_APPLICATION	Source type of payload is application.
PAYLOAD_FIELD_VALUES_END	End of payload field values.