pftypes.h File Reference

Go to the source code of this file.

Classes
struct	PFValue
Defines
#define	TOKEN   unsigned long
#define	MAX_CAMERAS   32
#define	INVALID_TOKEN   0
#define	F_PRIVATE   0x02
	Property is private.
#define	F_BIG   0x04
	Big endian, if Register node.
#define	F_RW   0x00
	Readable/Writeable.
#define	F_RO   0x10
	Readonly.
#define	F_WO   0x20
	Writeonly.
#define	F_INACTIVE   0x40
	Property is currently inactive.
#define	SET_FLOAT(v, f)   v.type = PF_FLOAT; v.value.f = f
#define	SET_INT(v, i)   v.type = PF_INT; v.value.f = i
#define	SET_STRING(v, s, l)
Typedefs
typedef int(	PropCallback )(TOKEN t)
typedef int(*	FeedbackFuncP )(int i)
Enumerations
enum	PropertyType {   PF_INVALID, PF_ROOT, PF_INT, PF_FLOAT,   PF_BOOL, PF_MODE, PF_REGISTER, PF_STRING,   PF_BUFFER, PF_STRUCT, PF_ARRAY, PF_COMMAND,   PF_EVENT }

---

Detailed Description

Photonfocus API data types

These are datatypes that have to be exported to the API.

WARNING: Changes in these data structures may affect API binary compatibility. If this is the case, the major library version number must be increased.

---

Define Documentation

#define F_PRIVATE   0x02

Property is private.

Property flags

These flags are queried via pfProperty_GetFlags().

All other bits are reserved for internal purposes.

#define INVALID_TOKEN   0

Invalid token value. When returned from pfProperty_ParseName(), a property of that name was not found. Note that pfDevice_GetRoot() may return the same value as INVALID_TOKEN, which is normal.

---

Typedef Documentation

typedef int(* FeedbackFuncP)(int i)

Feedback function pointer definition

See pfSetFeedback() in pfcam.h

---

Enumeration Type Documentation

enum PropertyType

Property data types

Enumerator:

PF_ROOT	ROOT NODE TYPE.
PF_INT	A 32 bit signed integer.
PF_FLOAT	A 4 byte float, single precision.
PF_BOOL	A boolean value (1: true, 0: false).
PF_MODE	A mode value. Only the values in the choice are valid.
PF_REGISTER	A register value (direct register export).
PF_STRING	A string value (constant or fixed lengh, 0 terminated).
PF_BUFFER	A buffer value. The length is specified in the len field.
PF_STRUCT	A struct value containing other properties.
PF_ARRAY	An array value, containing a struct or property.
PF_COMMAND	A command.
PF_EVENT	An event node.