INDI Support in MagAOX Apps

Collaboration diagram for INDI Support in MagAOX Apps:

Macros
#define	SET_INDI_NEWCALLBACK(class, prop)
	Declare and define the static callback for a new property request. More...
#define	SET_INDI_SETCALLBACK(class, prop)
	Declare and define the static callback for a set property request. More...
#define	INDI_NEWCALLBACK_DECL(class, prop)
	Declare the callback for a new property request, and declare and define the static wrapper. More...
#define	INDI_SETCALLBACK_DECL(class, prop)
	Declare the callback for a set property request, and declare and define the static wrapper. More...
#define	INDI_NEWCALLBACK_DEFN(class, prop)   int class::newCallBack_ ## prop
	Define the callback for a new property request. More...
#define	INDI_SETCALLBACK_DEFN(class, prop)   int class::setCallBack_ ## prop
	Define the callback for a set property request. More...
#define	INDI_NEWCALLBACK(prop)   st_newCallBack_ ## prop
	Get the name of the static callback wrapper for a new property. More...
#define	INDI_SETCALLBACK(prop)   st_setCallBack_ ## prop
	Get the name of the static callback wrapper for a set property. More...
#define	REG_INDI_NEWPROP(prop, propName, type)   registerIndiPropertyNew( prop, propName, type, pcf::IndiProperty::ReadWrite, pcf::IndiProperty::Idle, INDI_NEWCALLBACK(prop));
	Register a NEW INDI property with the class, using the standard callback name. More...
#define	REG_INDI_NEWPROP_NOCB(prop, propName, type)   registerIndiPropertyNew( prop, propName, type, pcf::IndiProperty::ReadOnly, pcf::IndiProperty::Idle, 0);
	Register a NEW INDI property with the class, with no callback. More...
#define	REG_INDI_SETPROP(prop, devName, propName)   registerIndiPropertySet( prop,devName, propName, INDI_SETCALLBACK(prop));
	Register a SET INDI property with the class, using the standard callback name. More...

Detailed Description

Macro Definition Documentation

INDI_NEWCALLBACK

#define INDI_NEWCALLBACK

(

prop

)

st_newCallBack_ ## prop

Get the name of the static callback wrapper for a new property.

Useful for passing the pointer to the callback.

Parameters

prop	the property member name (with no ")

Definition at line 125 of file indiMacros.hpp.

INDI_NEWCALLBACK_DECL

#define INDI_NEWCALLBACK_DECL	(		class,
			prop
	)

Value:

int newCallBack_ ## prop(const pcf::IndiProperty &ipRecv); \
                                           SET_INDI_NEWCALLBACK(class, prop)

Declare the callback for a new property request, and declare and define the static wrapper.

After including this, you still need to actually define the callback.

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 46 of file indiMacros.hpp.

INDI_NEWCALLBACK_DEFN

#define INDI_NEWCALLBACK_DEFN	(		class,
			prop
	)		int class::newCallBack_ ## prop

Define the callback for a new property request.

Creates a class::method definition, which must be appended with a const reference of type pcf::IndiProperty. Example usage for a class named xapp and an INDI property x:

INDI_NEWCALLBACK_DEFN(xapp, x)(const pcf::IndiProperty &ipRecv)
{
  //do stuff with ipRecv

  return 0; //Must return int.
}

After pre-processing the above code becomes

int xapp::newCallback_x(const pcf::IndiProperty &ipRecv)
{
  //do stuff with ipRecv

  return 0; //Must return int.
}

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 87 of file indiMacros.hpp.

INDI_SETCALLBACK

#define INDI_SETCALLBACK

(

prop

)

st_setCallBack_ ## prop

Get the name of the static callback wrapper for a set property.

Useful for passing the pointer to the callback.

Parameters

prop	the property member name (with no ")

Definition at line 134 of file indiMacros.hpp.

INDI_SETCALLBACK_DECL

#define INDI_SETCALLBACK_DECL	(		class,
			prop
	)

Value:

int setCallBack_ ## prop(const pcf::IndiProperty &ipRecv); \
                                           SET_INDI_SETCALLBACK(class, prop)

Declare the callback for a set property request, and declare and define the static wrapper.

After including this, you still need to actually define the callback.

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 57 of file indiMacros.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::whilePowerOff().

INDI_SETCALLBACK_DEFN

#define INDI_SETCALLBACK_DEFN	(		class,
			prop
	)		int class::setCallBack_ ## prop

Define the callback for a set property request.

Creates a class::method definition, which must be appended with a const reference of type pcf::IndiProperty. Example usage for a class named xapp and an INDI property x:

INDI_SETCALLBACK_DEFN(xapp, x)(const pcf::IndiProperty &ipRecv)
{
  //do stuff with ipRecv

  return 0; //Must return int.
}

After pre-processing the above code becomes

int xapp::setCallback_x(const pcf::IndiProperty &ipRecv)
{
  //do stuff with ipRecv

  return 0; //Must return int.
}

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 116 of file indiMacros.hpp.

REG_INDI_NEWPROP

#define REG_INDI_NEWPROP	(		prop,
			propName,
			type
	)		registerIndiPropertyNew( prop, propName, type, pcf::IndiProperty::ReadWrite, pcf::IndiProperty::Idle, INDI_NEWCALLBACK(prop));

Register a NEW INDI property with the class, using the standard callback name.

Is a wrapper for MagAOXApp::registerIndiPropertyNew.

Parameters

prop	the property member name, with no quotes
propName	the property name, in quotes
type	the property type, pcf::IndiProperty::Type
perm	the property permissions, pcf::IndiProperty::PropertyPermType
state	the property state, pcf::IndiProperty::PropertyStateType

Definition at line 147 of file indiMacros.hpp.

REG_INDI_NEWPROP_NOCB

#define REG_INDI_NEWPROP_NOCB	(		prop,
			propName,
			type
	)		registerIndiPropertyNew( prop, propName, type, pcf::IndiProperty::ReadOnly, pcf::IndiProperty::Idle, 0);

Register a NEW INDI property with the class, with no callback.

Is a wrapper for MagAOXApp::registerIndiPropertyNew with NULL callback.

Parameters

prop	the property member name, with no quotes
propName	the property name, in quotes
type	the property type, pcf::IndiProperty::Type
perm	the property permissions, pcf::IndiProperty::PropertyPermType
state	the property state, pcf::IndiProperty::PropertyStateType

Definition at line 160 of file indiMacros.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::setDefaults().

REG_INDI_SETPROP

#define REG_INDI_SETPROP	(		prop,
			devName,
			propName
	)		registerIndiPropertySet( prop,devName, propName, INDI_SETCALLBACK(prop));

Register a SET INDI property with the class, using the standard callback name.

Is a wrapper for MagAOXApp::registerIndiPropertySet.

Parameters

prop	the property member name, with no quotes
propName	the property name, in quotes
type	the property type, pcf::IndiProperty::Type
perm	the property permissions, pcf::IndiProperty::PropertyPermType
state	the property state, pcf::IndiProperty::PropertyStateType

Definition at line 173 of file indiMacros.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig().

SET_INDI_NEWCALLBACK

#define SET_INDI_NEWCALLBACK	(		class,
			prop
	)

Value:

static int st_ ## newCallBack ## _ ## prop( void * app, const pcf::IndiProperty &ipRecv)\
                                          {\
                                             return static_cast<class *>(app)->newCallBack ## _ ## prop(ipRecv);\
                                          }

Declare and define the static callback for a new property request.

You should not normally use this macro, it is called by INDI_NEWCALLBACK_DECL.

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 20 of file indiMacros.hpp.

SET_INDI_SETCALLBACK

#define SET_INDI_SETCALLBACK	(		class,
			prop
	)

Value:

static int st_ ## setCallBack ## _ ## prop( void * app, const pcf::IndiProperty &ipRecv)\
                                          {\
                                             return static_cast<class *>(app)->setCallBack ## _ ## prop(ipRecv);\
                                          }

Declare and define the static callback for a set property request.

You should not normally use this macro, it is called by INDI_SETCALLBACK_DECL.

Parameters

class	the class name (with no ")
prop	the property member name (with no ")

Definition at line 33 of file indiMacros.hpp.