oc_enums.h File Reference

#include "oc_helpers.h"
#include "util/oc_compiler.h"

Typedefs
typedef enum oc_enum_t	oc_enum_t
	generic enum values for resources that convey string enums More...
typedef enum oc_locn_t	oc_locn_t
	enum of location tags More...
typedef enum oc_pos_description_t	oc_pos_description_t
	enum of position tags More...

Enumerations
enum	oc_ace_permissions_t {   OC_PERM_NONE = 0 , OC_PERM_CREATE = (1 << 0) , OC_PERM_RETRIEVE , OC_PERM_UPDATE = (1 << 2) ,   OC_PERM_DELETE = (1 << 3) , OC_PERM_NOTIFY = (1 << 4) }
	ACE permissions, as bitmap. More...
enum	oc_enum_t {   OC_ENUM_ABORTED = 1 , OC_ENUM_ACTIVE , OC_ENUM_AIRDRY , OC_ENUM_ARMEDAWAY ,   OC_ENUM_ARMEDINSTANT , OC_ENUM_ARMEDMAXIMUM , OC_ENUM_ARMEDNIGHTSTAY , OC_ENUM_ARMEDSTAY ,   OC_ENUM_AROMA , OC_ENUM_AI , OC_ENUM_AUTO , OC_ENUM_BOILING ,   OC_ENUM_BREWING , OC_ENUM_CANCELLED , OC_ENUM_CIRCULATING , OC_ENUM_CLEANING ,   OC_ENUM_CLOTHES , OC_ENUM_COMPLETED , OC_ENUM_COOL , OC_ENUM_DELICATE ,   OC_ENUM_DISABLED , OC_ENUM_DOWN , OC_ENUM_DUAL , OC_ENUM_DRY ,   OC_ENUM_ENABLED , OC_ENUM_EXTENDED , OC_ENUM_FAN , OC_ENUM_FAST ,   OC_ENUM_FILTERMATERIAL , OC_ENUM_FOCUSED , OC_ENUM_GRINDING , OC_ENUM_HEATING ,   OC_ENUM_HEAVY , OC_ENUM_IDLE , OC_ENUM_INK , OC_ENUM_INKBLACK ,   OC_ENUM_INKCYAN , OC_ENUM_INKMAGENTA , OC_ENUM_INKTRICOLOUR , OC_ENUM_INKYELLOW ,   OC_ENUM_KEEPWARM , OC_ENUM_NORMAL , OC_ENUM_NOTSUPPORTED , OC_ENUM_PAUSE ,   OC_ENUM_PENDING , OC_ENUM_PENDINGHELD , OC_ENUM_PERMAPRESS , OC_ENUM_PREWASH ,   OC_ENUM_PROCESSING , OC_ENUM_PURE , OC_ENUM_QUICK , OC_ENUM_QUIET ,   OC_ENUM_RINSE , OC_ENUM_SECTORED , OC_ENUM_SILENT , OC_ENUM_SLEEP ,   OC_ENUM_SMART , OC_ENUM_SPOT , OC_ENUM_STEAM , OC_ENUM_STOPPED ,   OC_ENUM_SPIN , OC_ENUM_TESTING , OC_ENUM_TONER , OC_ENUM_TONERBLACK ,   OC_ENUM_TONERCYAN , OC_ENUM_TONERMAGENTA , OC_ENUM_TONERYELLOW , OC_ENUM_WARM ,   OC_ENUM_WASH , OC_ENUM_WET , OC_ENUM_WIND , OC_ENUM_WRINKLEPREVENT ,   OC_ENUM_ZIGZAG }
	generic enum values for resources that convey string enums More...
enum	oc_locn_t {   OCF_LOCN_UNKNOWN = 1 , OCF_LOCN_ATTIC , OCF_LOCN_BALCONY , OCF_LOCN_BALLROOM ,   OCF_LOCN_BATHROOM , OCF_LOCN_BEDROOM , OCF_LOCN_BORDER , OCF_LOCN_BOXROOM ,   OCF_LOCN_CELLAR , OCF_LOCN_CLOAKROOM , OCF_LOCN_CONSERVATORY , OCF_LOCN_CORRIDOR ,   OCF_LOCN_DECK , OCF_LOCN_DEN , OCF_LOCN_DININGROOM , OCF_LOCN_DRAWINGROOM ,   OCF_LOCN_DRIVEWAY , OCF_LOCN_DUNGEON , OCF_LOCN_ENSUITE , OCF_LOCN_ENTRANCE ,   OCF_LOCN_FAMILYROOM , OCF_LOCN_GARAGE , OCF_LOCN_GARDEN , OCF_LOCN_GUESTROOM ,   OCF_LOCN_HALL , OCF_LOCN_INDOOR , OCF_LOCN_KITCHEN , OCF_LOCN_LARDER ,   OCF_LOCN_LAWN , OCF_LOCN_LIBRARY , OCF_LOCN_LIVINGROOM , OCF_LOCN_LOUNGE ,   OCF_LOCN_MANCAVE , OCF_LOCN_MASTERBEDROOM , OCF_LOCN_MUSICROOM , OCF_LOCN_OFFICE ,   OCF_LOCN_OUTDOOR , OCF_LOCN_PANTRY , OCF_LOCN_PARKINGLOT , OCF_LOCN_PARLOUR ,   OCF_LOCN_PATIO , OCF_LOCN_RECEIPTIONROOM , OCF_LOCN_RESTROOM , OCF_LOCN_ROOF ,   OCF_LOCN_ROOFTERRACE , OCF_LOCN_SAUNA , OCF_LOCN_SCULLERY , OCF_LOCN_SHED ,   OCF_LOCN_SITTINGROOM , OCF_LOCN_SNUG , OCF_LOCN_SPA , OCF_LOCN_STUDIO ,   OCF_LOCN_SUITE , OCF_LOCN_SWIMMINGPOOL , OCF_LOCN_TERRACE , OCF_LOCN_TOILET ,   OCF_LOCN_UTILITYROOM , OCF_LOCN_VEGETABLEPLOT , OCF_LOCN_WARD , OCF_LOCN_YARD }
	enum of location tags More...
enum	oc_pos_description_t {   OC_POS_UNKNOWN = 1 , OC_POS_TOP , OC_POS_BOTTOM , OC_POS_LEFT ,   OC_POS_RIGHT , OC_POS_CENTRE , OC_POS_TOPLEFT , OC_POS_BOTTOMLEFT ,   OC_POS_CENTRELEFT , OC_POS_CENTRERIGHT , OC_POS_BOTTOMRIGHT , OC_POS_TOPRIGHT ,   OC_POS_TOPCENTRE , OC_POS_BOTTOMCENTRE }
	enum of position tags More...

Functions
const char *	oc_enum_locn_to_str (oc_locn_t locn)
	convert the location enum value to string More...
const char *	oc_enum_pos_desc_to_str (oc_pos_description_t pos)
	convert the position description enum value to string More...
const char *	oc_enum_to_str (oc_enum_t val)
	convert enum value to string More...
oc_locn_t	oc_str_to_enum_locn (oc_string_t locn_str, bool *oc_defined)
	convert a string to the location enum value More...

Typedef Documentation

oc_enum_t

typedef enum oc_enum_t oc_enum_t

generic enum values for resources that convey string enums

oc_locn_t

typedef enum oc_locn_t oc_locn_t

enum of location tags

oc_pos_description_t

typedef enum oc_pos_description_t oc_pos_description_t

enum of position tags

Enumeration Type Documentation

oc_ace_permissions_t

enum oc_ace_permissions_t

ACE permissions, as bitmap.

Enumerator
OC_PERM_NONE	no permissions
OC_PERM_CREATE	Create permission is granted.
OC_PERM_RETRIEVE	Read, observe, discover permission is granted.
OC_PERM_UPDATE	Write, update permission is granted.
OC_PERM_DELETE	Delete permission is granted.
OC_PERM_NOTIFY	Notify permission is granted.

oc_enum_t

enum oc_enum_t

generic enum values for resources that convey string enums

oc_locn_t

enum oc_locn_t

enum of location tags

oc_pos_description_t

enum oc_pos_description_t

enum of position tags

Function Documentation

oc_enum_locn_to_str()

const char* oc_enum_locn_to_str

(

oc_locn_t

locn

)

convert the location enum value to string

Parameters

locn	the location enum value

Returns

const char* the string

oc_enum_pos_desc_to_str()

const char* oc_enum_pos_desc_to_str

(

oc_pos_description_t

pos

)

convert the position description enum value to string

Parameters

pos	the enum value of the position description

Returns

const char* the string

oc_enum_to_str()

const char* oc_enum_to_str

(

oc_enum_t

val

)

convert enum value to string

Parameters

val	the enum value

Returns

const char* the string

oc_str_to_enum_locn()

oc_locn_t oc_str_to_enum_locn	(	oc_string_t	locn_str,
		bool *	oc_defined
	)

convert a string to the location enum value

Parameters

locn_str	the input string
oc_defined	value to check if the conversion is successfull (cannot be NULL)

Returns

oc_locn_t the location value