Tizen RT Public API  v1.1 D4
_st_things_representation Struct Reference

Structure for Representation. More...

#include <st_things_types.h>

Data Fields

void * payload
 
bool(* get_str_value )(struct _st_things_representation *rep, const char *key, char **value)
 API for getting the value of string type property with a key. More...
 
bool(* get_bool_value )(struct _st_things_representation *rep, const char *key, bool *value)
 API for getting the value of boolean type property with a key. More...
 
bool(* get_int_value )(struct _st_things_representation *rep, const char *key, int64_t *value)
 API for getting the value of integer type property with a key. More...
 
bool(* get_double_value )(struct _st_things_representation *rep, const char *key, double *value)
 API for getting the value of double type property with a key. More...
 
bool(* get_byte_value )(struct _st_things_representation *rep, const char *key, uint8_t **value, size_t *size)
 API for getting the value of byte array type property with a key. More...
 
bool(* get_object_value )(struct _st_things_representation *rep, const char *key, struct _st_things_representation **value)
 API for getting the value of object type property with a key. More...
 
bool(* set_str_value )(struct _st_things_representation *rep, const char *key, const char *value)
 API for setting the value of string type property with a key. More...
 
bool(* set_bool_value )(struct _st_things_representation *rep, const char *key, bool value)
 API for setting the value of boolean type property with a key. More...
 
bool(* set_int_value )(struct _st_things_representation *rep, const char *key, int64_t value)
 API for setting the value of integer type property with a key. More...
 
bool(* set_double_value )(struct _st_things_representation *rep, const char *key, double value)
 API for setting the value of double type property with a key. More...
 
bool(* set_byte_value )(struct _st_things_representation *rep, const char *key, const uint8_t *value, size_t size)
 API for setting the value of byte array type property with a key. More...
 
bool(* set_object_value )(struct _st_things_representation *rep, const char *key, const struct _st_things_representation *value)
 API for setting the value of object type property with a key. More...
 
bool(* get_str_array_value )(struct _st_things_representation *rep, const char *key, char ***array, size_t *length)
 API for getting the value of string array type property with a key. More...
 
bool(* get_int_array_value )(struct _st_things_representation *rep, const char *key, int64_t **array, size_t *length)
 API for getting the value of integer array type property with a key. More...
 
bool(* get_double_array_value )(struct _st_things_representation *rep, const char *key, double **array, size_t *length)
 API for getting the value of double array type property with a key. More...
 
bool(* get_object_array_value )(struct _st_things_representation *rep, const char *key, struct _st_things_representation ***array, size_t *length)
 API for getting the value of object array type property with a key. More...
 
bool(* set_str_array_value )(struct _st_things_representation *rep, const char *key, const char **array, size_t length)
 API for setting the value of string array type property with a key. More...
 
bool(* set_int_array_value )(struct _st_things_representation *rep, const char *key, const int64_t *array, size_t length)
 API for setting the value of integer array type property with a key. More...
 
bool(* set_double_array_value )(struct _st_things_representation *rep, const char *key, const double *array, size_t length)
 API for setting the value of double array type property with a key. More...
 
bool(* set_object_array_value )(struct _st_things_representation *rep, const char *key, const struct _st_things_representation **array, size_t length)
 API for setting the value of object array type property with a key. More...
 

Detailed Description

Structure for Representation.

Since
Tizen RT v1.1

Definition at line 70 of file st_things_types.h.

Field Documentation

◆ get_bool_value

bool(* get_bool_value) (struct _st_things_representation *rep, const char *key, bool *value)

API for getting the value of boolean type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueBool value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 92 of file st_things_types.h.

◆ get_byte_value

bool(* get_byte_value) (struct _st_things_representation *rep, const char *key, uint8_t **value, size_t *size)

API for getting the value of byte array type property with a key.

Remarks
This API will return deep-copied byte value as out parameter, so application must free it after use.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueByte value
[out]sizeSize of Byte value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 124 of file st_things_types.h.

◆ get_double_array_value

bool(* get_double_array_value) (struct _st_things_representation *rep, const char *key, double **array, size_t *length)

API for getting the value of double array type property with a key.

Remarks
This API will return deep-copied array value as out parameter, so application must free it after use.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the array type of value.
[out]arrayReference of the double array where the value will be copied.
[out]lengthTotal number of elements in the array.
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 236 of file st_things_types.h.

◆ get_double_value

bool(* get_double_value) (struct _st_things_representation *rep, const char *key, double *value)

API for getting the value of double type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueDouble value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 112 of file st_things_types.h.

◆ get_int_array_value

bool(* get_int_array_value) (struct _st_things_representation *rep, const char *key, int64_t **array, size_t *length)

API for getting the value of integer array type property with a key.

Remarks
This API will return deep-copied array value as out parameter, so application must free it after use.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the array type of value.
[out]arrayReference of the integer array where the value will be copied.
[out]lengthTotal number of elements in the array.
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 224 of file st_things_types.h.

◆ get_int_value

bool(* get_int_value) (struct _st_things_representation *rep, const char *key, int64_t *value)

API for getting the value of integer type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueInteger value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 102 of file st_things_types.h.

◆ get_object_array_value

bool(* get_object_array_value) (struct _st_things_representation *rep, const char *key, struct _st_things_representation ***array, size_t *length)

API for getting the value of object array type property with a key.

Remarks
This API will return deep-copied array value as out parameter, so application must free it after use.
To free each object in array, st_things_destroy_representation_inst() in st_things.h should be used.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the array type of value.
[out]arrayReference of the object array where the value will be copied.
[out]lengthTotal number of elements in the array.
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 249 of file st_things_types.h.

◆ get_object_value

bool(* get_object_value) (struct _st_things_representation *rep, const char *key, struct _st_things_representation **value)

API for getting the value of object type property with a key.

Remarks
This API will return deep-copied object value as out parameter, so application must free it after use.
To free an object, st_things_destroy_representation_inst() in st_things.h should be used.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueObject value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 136 of file st_things_types.h.

◆ get_str_array_value

bool(* get_str_array_value) (struct _st_things_representation *rep, const char *key, char ***array, size_t *length)

API for getting the value of string array type property with a key.

Remarks
This API will return deep-copied array value as out parameter, so application must free it after use.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the array type of value.
[out]arrayReference of the string array to where the value will be copied.
[out]lengthTotal number of elements in the array.
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 212 of file st_things_types.h.

◆ get_str_value

bool(* get_str_value) (struct _st_things_representation *rep, const char *key, char **value)

API for getting the value of string type property with a key.

Remarks
This API will return deep-copied string value as out parameter, so application must free it after use.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[out]valueString value
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 82 of file st_things_types.h.

◆ payload

void* payload

Payload of representation

Definition at line 71 of file st_things_types.h.

◆ set_bool_value

bool(* set_bool_value) (struct _st_things_representation *rep, const char *key, bool value)

API for setting the value of boolean type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueBool value.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 157 of file st_things_types.h.

◆ set_byte_value

bool(* set_byte_value) (struct _st_things_representation *rep, const char *key, const uint8_t *value, size_t size)

API for setting the value of byte array type property with a key.

Remarks
This API will deep-copy the byte value inside, so application still has an ownership of memory for the byte value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueByte value.
[in]sizeSize of Byte value.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 189 of file st_things_types.h.

◆ set_double_array_value

bool(* set_double_array_value) (struct _st_things_representation *rep, const char *key, const double *array, size_t length)

API for setting the value of double array type property with a key.

Remarks
This API will deep-copy the array value inside, so application still has an ownership of memory for the array value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[in]arrayDouble array type value.
[in]lengthTotal number of elements in the array.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 285 of file st_things_types.h.

◆ set_double_value

bool(* set_double_value) (struct _st_things_representation *rep, const char *key, double value)

API for setting the value of double type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueDouble value.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 177 of file st_things_types.h.

◆ set_int_array_value

bool(* set_int_array_value) (struct _st_things_representation *rep, const char *key, const int64_t *array, size_t length)

API for setting the value of integer array type property with a key.

Remarks
This API will deep-copy the array value inside, so application still has an ownership of memory for the array value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[in]arrayInteger array type value.
[in]lengthTotal number of elements in the array.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 273 of file st_things_types.h.

◆ set_int_value

bool(* set_int_value) (struct _st_things_representation *rep, const char *key, int64_t value)

API for setting the value of integer type property with a key.

Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueInteger value.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 167 of file st_things_types.h.

◆ set_object_array_value

bool(* set_object_array_value) (struct _st_things_representation *rep, const char *key, const struct _st_things_representation **array, size_t length)

API for setting the value of object array type property with a key.

Remarks
This API will deep-copy the array value inside, so application still has an ownership of memory for the array value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[in]arrayObject array type value.
[in]lengthTotal number of elements in the array.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 297 of file st_things_types.h.

◆ set_object_value

bool(* set_object_value) (struct _st_things_representation *rep, const char *key, const struct _st_things_representation *value)

API for setting the value of object type property with a key.

Remarks
This API will deep-copy the object value inside, so application still has an ownership of memory for the object value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueObject value.
Returns
true if value exist, otherwise false
Since
Tizen RT v1.1

Definition at line 200 of file st_things_types.h.

◆ set_str_array_value

bool(* set_str_array_value) (struct _st_things_representation *rep, const char *key, const char **array, size_t length)

API for setting the value of string array type property with a key.

Remarks
This API will deep-copy the array value inside, so application still has an ownership of memory for the array value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which represents the value.
[in]arrayString array type value.
[in]lengthTotal number of elements in the array.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 261 of file st_things_types.h.

◆ set_str_value

bool(* set_str_value) (struct _st_things_representation *rep, const char *key, const char *value)

API for setting the value of string type property with a key.

Remarks
This API will deep-copy the string value inside, so application still has an ownership of memory for the string value.
Parameters
[in]repInstance of Representation.
[in]keyProperty Name which will represent the value.
[in]valueString value.
Returns
true if setting value is successful, otherwise false
Since
Tizen RT v1.1

Definition at line 147 of file st_things_types.h.


The documentation for this struct was generated from the following file: