csu3_am335x/EVSE/GPL/uecho-1.2.3/include/uecho/property.h

/******************************************************************
 *
 * uEcho for C
 *
 * Copyright (C) Satoshi Konno 2015
 *
 * This is licensed under BSD-style license, see file COPYING.
 *
 ******************************************************************/

#ifndef _UECHO_PROPERTY_H_
#define _UECHO_PROPERTY_H_

#include <uecho/typedef.h>

#ifdef __cplusplus
extern "C" {
#endif

/****************************************
 * Constant
 ****************************************/

enum {
  uEchoPropertyCodeMin = 0x80,
  uEchoPropertyCodeMax = 0xFF,
};

/****************************************
 * Data Type
 ****************************************/

typedef byte uEchoPropertyCode;

typedef enum {
  uEchoPropertyAttrNone = 0x00,
  uEchoPropertyAttrRead = 0x01,
  uEchoPropertyAttrWrite = 0x02,
  uEchoPropertyAttrAnno = 0x04,
  uEchoPropertyAttrReadWrite = uEchoPropertyAttrRead | uEchoPropertyAttrWrite,
  uEchoPropertyAttrReadAnno = uEchoPropertyAttrRead | uEchoPropertyAttrAnno,
  uEchoPropertyAttrReadRequired = 0x10,
  uEchoPropertyAttrWriteRequired = 0x20,
  uEchoPropertyAttrAnnoRequired = 0x40,
} uEchoPropertyAttr;

typedef enum {
  uEchoPropertyTypeNone = 0x00,
  uEchoPropertyTypeNumber = 0x01,
  uEchoPropertyTypeState = 0x02,
  uEchoPropertyTypeNumeric = 0x03,
  uEchoPropertyTypeLevel = 0x04,
  uEchoPropertyTypeDateTime = 0x05,
  uEchoPropertyTypeDate = 0x06,
  uEchoPropertyTypeTime = 0x07,
  uEchoPropertyTypeBitmap = 0x10,
  uEchoPropertyTypeArray = 0x11,
  uEchoPropertyTypeObject = 0x12,
  uEchoPropertyTypeOneOf = 0x13,
  uEchoPropertyTypeRaw = 0x20,
} uEchoPropertyType;

#if !defined(_UECHO_PROPERTY_INTERNAL_H_)
typedef void uEchoProperty;
#endif

/****************************************
 * Function
 ****************************************/

uEchoProperty* uecho_property_new(void);
bool uecho_property_delete(uEchoProperty* prop);

bool uecho_property_setdata(uEchoProperty* prop, const byte* data, size_t data_size);
bool uecho_property_setintegerdata(uEchoProperty* prop, int data, size_t data_size);
bool uecho_property_setbytedata(uEchoProperty* prop, byte data);
bool uecho_property_adddata(uEchoProperty* prop, const byte* data, size_t data_size);
bool uecho_property_addbytedata(uEchoProperty* prop, const byte data);
bool uecho_property_cleardata(uEchoProperty* prop);

uEchoProperty* uecho_property_next(uEchoProperty* prop);
void uecho_property_remove(uEchoProperty* prop);

void uecho_property_setname(uEchoProperty* prop, const char* name);
const char* uecho_property_getname(uEchoProperty* prop);

void uecho_property_setcode(uEchoProperty* prop, uEchoPropertyCode val);
uEchoPropertyCode uecho_property_getcode(uEchoProperty* prop);

size_t uecho_property_getdatasize(uEchoProperty* prop);
byte* uecho_property_getdata(uEchoProperty* prop);
bool uecho_property_getintegerdata(uEchoProperty* prop, int* data);
bool uecho_property_getbytedata(uEchoProperty* prop, byte* data);
bool uecho_property_getpropertymapcount(uEchoProperty* prop, size_t* count);
bool uecho_property_getpropertymapcodes(uEchoProperty* prop, uEchoPropertyCode* prop_codes, size_t count);
bool uecho_property_isdataequal(uEchoProperty* prop, const byte* data, size_t data_size);

void uecho_property_setattribute(uEchoProperty* prop, uEchoPropertyAttr val);
uEchoPropertyAttr uecho_property_getattribute(uEchoProperty* prop);
bool uecho_property_isreadable(uEchoProperty* prop);
bool uecho_property_isreadrequired(uEchoProperty* prop);
bool uecho_property_iswritable(uEchoProperty* prop);
bool uecho_property_iswriterequired(uEchoProperty* prop);
bool uecho_property_isreadonly(uEchoProperty* prop);
bool uecho_property_iswriteonly(uEchoProperty* prop);
bool uecho_property_isannounceable(uEchoProperty* prop);
bool uecho_property_isannouncerequired(uEchoProperty* prop);

void uecho_property_settype(uEchoProperty* prop, uEchoPropertyType val);
uEchoPropertyType uecho_property_gettype(uEchoProperty* prop);

uEchoProperty* uecho_property_copy(uEchoProperty* prop);
bool uecho_property_equals(uEchoProperty* prop1, uEchoProperty* prop2);

#ifdef __cplusplus
} /* extern C */
#endif

#endif /* _UECHO_NODE_H_ */