Studer Innotec Xtender Serial Communication C Library 1.5.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Enumerations Enumerator Macros Pages
scom_property.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2014 Studer Innotec SA
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 */
22
27 #ifndef SCOM_PROPERTY_H
28 #define SCOM_PROPERTY_H
29
30 #include "scom_data_link.h"
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
39 typedef enum {
40 SCOM_USER_INFO_OBJECT_TYPE = 0x1,
41 SCOM_PARAMETER_OBJECT_TYPE = 0x2,
42 } scom_object_type_t;
43
44
48 typedef struct {
50 scom_frame_t* frame;
51
53 scom_object_type_t object_type;
54
56 uint32_t object_id;
57
59 uint16_t property_id;
60
62 size_t value_length;
63
65 char* value_buffer;
66
68 size_t value_buffer_size;
69 } scom_property_t;
70
71
72 void scom_initialize_property(scom_property_t* property, scom_frame_t* frame);
73
74 void scom_encode_read_property(scom_property_t* property);
75 void scom_encode_write_property(scom_property_t* property);
76
77 void scom_decode_read_property(scom_property_t* property);
78 void scom_decode_write_property(scom_property_t* property);
79
80 #ifdef __cplusplus
81 }
82 #endif
83
84 #endif