kstars

indiapi.h File Reference

Detailed Description

Constants and Data structure definitions for the interface to the reference INDI C API implementation.

Author:: Elwood C. Downey

Definition in file indiapi.h.

This graph shows which files directly or indirectly include this file:


Classes
struct	_IBLOBVectorProperty
	BLOB (Binary Large Object) vector property descriptor. More...
struct	_ILightVectorProperty
	Light vector property descriptor. More...
struct	_INumberVectorProperty
	Number vector property descriptor. More...
struct	_ISwitchVectorProperty
	Switch vector property descriptor. More...
struct	_ITextVectorProperty
	Text vector property descriptor. More...
struct	IBLOB
	One Blob (Binary Large Object) descriptor. More...
struct	ILight
	One light descriptor. More...
struct	INumber
	One number descriptor. More...
struct	ISwitch
	One switch descriptor. More...
struct	IText
	One text descriptor. More...
Defines
#define	INDI_LIBV 0.6
#define	INDIV 1.7
#define	MAXINDIBLOBFMT 32
#define	MAXINDIDEVICE 32
#define	MAXINDIFORMAT 32
#define	MAXINDIGROUP 32
#define	MAXINDILABEL 32
#define	MAXINDINAME 32
#define	MAXINDITSTAMP 32
#define	NARRAY(a) (sizeof(a)/sizeof(a[0]))
Typedefs
typedef struct _IBLOBVectorProperty	IBLOBVectorProperty
typedef struct _ILightVectorProperty	ILightVectorProperty
typedef struct _INumberVectorProperty	INumberVectorProperty
typedef struct _ISwitchVectorProperty	ISwitchVectorProperty
typedef struct _ITextVectorProperty	ITextVectorProperty
Enumerations
enum	IPerm { IP_RO, IP_WO, IP_RW }
enum	IPState { IPS_IDLE, IPS_OK, IPS_BUSY, IPS_ALERT }
enum	ISRule { ISR_1OFMANY, ISR_ATMOST1, ISR_NOFMANY }
enum	ISState { ISS_OFF, ISS_ON }

Define Documentation

#define INDI_LIBV 0.6

Definition at line 76 of file indiapi.h.

#define INDIV 1.7

Definition at line 72 of file indiapi.h.

#define MAXINDIBLOBFMT 32

Definition at line 130 of file indiapi.h.

#define MAXINDIDEVICE 32

Definition at line 127 of file indiapi.h.

#define MAXINDIFORMAT 32

Definition at line 129 of file indiapi.h.

#define MAXINDIGROUP 32

Definition at line 128 of file indiapi.h.

#define MAXINDILABEL 32

Definition at line 126 of file indiapi.h.

#define MAXINDINAME 32

Definition at line 125 of file indiapi.h.

#define MAXINDITSTAMP 32

Definition at line 131 of file indiapi.h.

#define NARRAY ( a ) (sizeof(a)/sizeof(a[0]))

Handy macro to find the number of elements in array a[].

Must be used with actual array, not pointer.

Definition at line 386 of file indiapi.h.

Typedef Documentation

typedef struct _IBLOBVectorProperty IBLOBVectorProperty

typedef struct _ILightVectorProperty ILightVectorProperty

typedef struct _INumberVectorProperty INumberVectorProperty

typedef struct _ISwitchVectorProperty ISwitchVectorProperty

typedef struct _ITextVectorProperty ITextVectorProperty

Enumeration Type Documentation

enum IPerm

Permission hint, with respect to client.

Enumerator:

IP_RO	Read Only
IP_WO	Write Only
IP_RW	Read & Write

Definition at line 115 of file indiapi.h.

enum IPState

Property state.

Enumerator:

IPS_IDLE	State is idle
IPS_OK	State is ok
IPS_BUSY	State is busy
IPS_ALERT	State is alert

Definition at line 94 of file indiapi.h.

enum ISRule

Switch vector rule hint.

Enumerator:

ISR_1OFMANY	Only 1 switch of many can be ON (e.g. radio buttons)
ISR_ATMOST1	There is only ONE switch
ISR_NOFMANY	Any number of switches can be ON (e.g. check boxes)

Definition at line 105 of file indiapi.h.

enum ISState

Switch state.

Enumerator:

ISS_OFF	Switch is OFF
ISS_ON	Switch is ON

Definition at line 85 of file indiapi.h.

kstars

indiapi.h File Reference

Detailed Description

Classes

Defines

Typedefs

Enumerations

Define Documentation

Typedef Documentation

Enumeration Type Documentation

kstars

kdeedu