data_types.h

Go to the documentation of this file.

/*!**********************************************************************
 *
 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
 *            All rights reserved.
 *
 *************************************************************************
 *
 * @file     data_types.h
 * @date     Jun 27, 2016
 * @brief    Data types module header file.
 *
 * This module contains data type definitions.
 *
 ************************************************************************/

#ifndef DATA_TYPES_H_
#define DATA_TYPES_H_

#include "string_type.h"

typedef struct mcl_time_series_t time_series_t;

typedef struct mcl_json_t mcl_json_t;

// ----------------- item_meta_t -----------------------------

typedef struct item_meta_details_t
{
    string_t *routing;            
} item_meta_details_t;

typedef struct item_meta_payload_details_time_series_t
{
    string_t *configuration_id; 
} item_meta_payload_details_time_series_t;

typedef struct item_meta_payload_details_file_t
{
    string_t *file_name;          
    string_t *creation_date;      
    string_t *file_type;          
} item_meta_payload_details_file_t;

typedef struct item_meta_payload_details_custom_t
{
    mcl_json_t *details_json; 
} item_meta_payload_details_custom_t;

typedef union item_meta_payload_details_union_t
{
    item_meta_payload_details_time_series_t time_series_details; 
    item_meta_payload_details_file_t file_details;               
    item_meta_payload_details_custom_t custom_details;           
} item_meta_payload_details_union_t;

typedef struct item_meta_payload_t
{
    string_t *type;                            
    string_t *version;                         
    item_meta_payload_details_union_t details; 
} item_meta_payload_t;

typedef struct item_meta_t
{
    string_t *content_id;        
    string_t *type;              
    string_t *version;           

    item_meta_details_t details; 
    item_meta_payload_t payload; 
} item_meta_t;

// ----------------- time_series_payload_t -----------------------------

typedef struct mcl_time_series_value_t
{
    string_t *data_point_id; 
    string_t *value;         
    string_t *quality_code;  
} time_series_value_t;

typedef struct mcl_time_series_value_set_t
{
    string_t *timestamp; 

    // time_series_value_t
    list_t *values; 
    time_series_t *parent; 
} time_series_value_set_t;

typedef struct time_series_payload_t
{
    // time_series_value_set_t
    list_t *value_sets; 
} time_series_payload_t;

// ----------------- event_payload_t -----------------------------

typedef struct event_payload_t
{
    string_t *id;             
    string_t *correlation_id; 

    // string_ts
    string_t *timestamp;            
    mcl_int32_t severity;           
    string_t *description;          
    string_t *type;                 
    string_t *version;              
    mcl_json_t *details;            
} event_payload_t;

// ----------------- file_payload_t -----------------------------

typedef struct file_payload_t
{
    mcl_uint8_t *buffer;   
    mcl_int64_t size;      
    mcl_size_t start_byte; 
    mcl_size_t end_byte;   
} file_payload_t;

// ----------------- custom_data_payload_t -----------------------------

typedef struct binary_payload_t
{
    mcl_uint8_t *buffer; 
    mcl_size_t size;     
} binary_payload_t;

// ----------------- data_source_configuration_payload_t -----------------------------

typedef struct data_point_t
{
    string_t *id;            
    string_t *name;          
    string_t *description;   
    string_t *type;          
    string_t *unit;          
    mcl_json_t *custom_data; 
} data_point_t;

typedef struct mcl_data_source_t
{
    string_t *name;        
    string_t *description; 

    // data_point_t *;
    list_t *data_points;     
    mcl_json_t *custom_data; 
} data_source_t;

typedef struct data_source_configuration_payload_t
{
    string_t *configuration_id; 

    // data_source_t *
    list_t *data_sources; 
} data_source_configuration_payload_t;

typedef 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                           
} E_META_FIELD_NAMES;

typedef 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                                      
} E_PAYLOAD_FIELD_NAMES;

typedef 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                               
} E_META_FIELD_VALUES;

typedef 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               
} E_PAYLOAD_FIELD_VALUES;

typedef 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                
} E_CONTENT_TYPE_VALUES;

extern string_t meta_field_names[META_FIELD_NAMES_END];
extern string_t meta_field_values[META_FIELD_VALUES_END];
extern string_t payload_field_values[PAYLOAD_FIELD_VALUES_END];
extern string_t payload_field_names[PAYLOAD_FIELD_NAMES_END];
extern string_t content_type_values[CONTENT_TYPE_VALUES_END];
#endif //MCL_DATA_TYPES_H_