
Macros | |
| #define | SET_INDI_NEWCALLBACK(class, prop) |
| Declare and define the static callback for a new property request. | |
| #define | SET_INDI_SETCALLBACK(class, prop) |
| Declare and define the static callback for a set property request. | |
| #define | INDI_NEWCALLBACK_DECL(class, prop) |
| Declare the callback for a new property request, and declare and define the static wrapper. | |
| #define | INDI_SETCALLBACK_DECL(class, prop) |
| Declare the callback for a set property request, and declare and define the static wrapper. | |
| #define | INDI_NEWCALLBACK_DEFN(class, prop) int class::newCallBack_ ## prop |
| Define the callback for a new property request. | |
| #define | INDI_SETCALLBACK_DEFN(class, prop) int class::setCallBack_ ## prop |
| Define the callback for a set property request. | |
| #define | INDI_NEWCALLBACK(prop) st_newCallBack_ ## prop |
| Get the name of the static callback wrapper for a new property. | |
| #define | INDI_SETCALLBACK(prop) st_setCallBack_ ## prop |
| Get the name of the static callback wrapper for a set property. | |
| #define | REG_INDI_NEWPROP(prop, propName, type) |
| Register a NEW INDI property with the class, using the standard callback name. | |
| #define | REG_INDI_NEWPROP_NOSETUP(prop) |
| Register a NEW INDI property with the class, using the standard callback name. | |
| #define | REG_INDI_NEWPROP_NOCB(prop, propName, type) |
| Register a NEW INDI property with the class, with no callback. | |
| #define | REG_INDI_NEWPROP_NOCB_DERIVED(prop, propName, type) |
| Register a NEW INDI property with the class, with no callback, using the derived class. | |
| #define | REG_INDI_SETPROP(prop, devName, propName) |
| Register a SET INDI property with the class, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_TEXT(prop, name, label, group) |
| Create and register a NEW INDI property as a standard text, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_NUMBERF(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as float, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_NUMBERD(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as double, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_NUMBERI(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as int, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_NUMBERU(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as unsigned int, using the standard callback name. | |
| #define | CREATE_REG_INDI_RO_NUMBER(prop, name, label, group) |
| Create and register a RO INDI property as a number, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_TOGGLESWITCH(prop, name) |
| Create and register a NEW INDI property as a standard toggle switch, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_TOGGLESWITCH_NOCB(prop, name) |
| Create and register a read-only INDI property as a standard toggle switch, with no callback. | |
| #define | CREATE_REG_INDI_NEW_REQUESTSWITCH(prop, name) |
| Create and register a NEW INDI property as a standard request switch, using the standard callback name. | |
| #define | CREATE_REG_INDI_NEW_NUMBERF_DERIVED(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as float, using the standard callback name, using the derived class. | |
| #define | CREATE_REG_INDI_NEW_NUMBERI_DERIVED(prop, name, min, max, step, format, label, group) |
| Create and register a NEW INDI property as a standard number as int, using the standard callback name, using the derived class. | |
| #define | CREATE_REG_INDI_NEW_TOGGLESWITCH_DERIVED(prop, name) |
| Create and register a NEW INDI property as a standard toggle switch, using the standard callback name, using the derived class. | |
| #define | CREATE_REG_INDI_NEW_REQUESTSWITCH_DERIVED(prop, name) |
| Create and register a NEW INDI property as a standard request switch, using the standard callback name, using the derived class. | |
| #define CREATE_REG_INDI_NEW_NUMBERD | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as double, using the standard callback name.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking. prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 374 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_NUMBERF | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as float, using the standard callback name.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking. prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 347 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_NUMBERF_DERIVED | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as float, using the standard callback name, using the derived class.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking. prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] the GUI label suggestion for this property |
| group | [in] the group for this property |
Definition at line 537 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_NUMBERI | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as int, using the standard callback name.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 401 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_NUMBERI_DERIVED | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as int, using the standard callback name, using the derived class.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] the GUI label suggestion for this property |
| group | [in] the group for this property |
Definition at line 565 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_NUMBERU | ( | prop, | |
| name, | |||
| min, | |||
| max, | |||
| step, | |||
| format, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard number as unsigned int, using the standard callback name.
This wraps createStandardIndiNumber and registerIndiPropertyNew, with error checking prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| min | [in] the minimum value for the elements, applied to both target and current |
| max | [in] the minimum value for the elements, applied to both target and current |
| step | [in] the step size for the elements, applied to both target and current |
| format | [in] the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 428 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_REQUESTSWITCH | ( | prop, | |
| name | |||
| ) |
Create and register a NEW INDI property as a standard request switch, using the standard callback name.
This wraps createStandardIndiRequestSw and registerIndiPropertyNew, with error checking
| prop | the property member name, with no quotes |
| name | he property name, in quotes |
Definition at line 510 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_REQUESTSWITCH_DERIVED | ( | prop, | |
| name | |||
| ) |
Create and register a NEW INDI property as a standard request switch, using the standard callback name, using the derived class.
This wraps createStandardIndiRequestSw and registerIndiPropertyNew, with error checking
| prop | the property member name, with no quotes |
| name | he property name, in quotes |
Definition at line 605 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_TEXT | ( | prop, | |
| name, | |||
| label, | |||
| group | |||
| ) |
Create and register a NEW INDI property as a standard text, using the standard callback name.
This wraps createStandardIndiText and registerIndiPropertyNew, with error checking. prop will have elements "current" and "target".
| prop | [out] the property to create and setup |
| name | [in] the name of the property. |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 320 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_TOGGLESWITCH | ( | prop, | |
| name | |||
| ) |
Create and register a NEW INDI property as a standard toggle switch, using the standard callback name.
This wraps createStandardIndiToggleSw and registerIndiPropertyNew, with error checking
| prop | the property member name, with no quotes |
| name | he property name, in quotes |
Definition at line 470 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_TOGGLESWITCH_DERIVED | ( | prop, | |
| name | |||
| ) |
Create and register a NEW INDI property as a standard toggle switch, using the standard callback name, using the derived class.
This wraps createStandardIndiToggleSw and registerIndiPropertyNew, with error checking
| prop | the property member name, with no quotes |
| name | he property name, in quotes |
Definition at line 585 of file indiMacros.hpp.
| #define CREATE_REG_INDI_NEW_TOGGLESWITCH_NOCB | ( | prop, | |
| name | |||
| ) |
Create and register a read-only INDI property as a standard toggle switch, with no callback.
This wraps createStandardIndiToggleSw and registerIndiPropertyNew with null callback, with error checking
| prop | the property member name, with no quotes |
| name | he property name, in quotes |
Definition at line 490 of file indiMacros.hpp.
| #define CREATE_REG_INDI_RO_NUMBER | ( | prop, | |
| name, | |||
| label, | |||
| group | |||
| ) |
Create and register a RO INDI property as a number, using the standard callback name.
This wraps createROIndiNumber and registerIndiPropertyReadOnly, with error checking.
| prop | [out] the property to create and setup |
| name | [in] the name of the property |
| label | [in] [optional] the GUI label suggestion for this property |
| group | [in] [optional] the group for this property |
Definition at line 450 of file indiMacros.hpp.
| #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.
| prop | the property member name (with no ") |
Definition at line 208 of file indiMacros.hpp.
| #define INDI_NEWCALLBACK_DECL | ( | 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.
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 48 of file indiMacros.hpp.
| #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:
After pre-processing the above code becomes
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 89 of file indiMacros.hpp.
| #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.
| prop | the property member name (with no ") |
Definition at line 217 of file indiMacros.hpp.
| #define INDI_SETCALLBACK_DECL | ( | 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.
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 59 of file indiMacros.hpp.
| #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:
After pre-processing the above code becomes
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 118 of file indiMacros.hpp.
| #define REG_INDI_NEWPROP | ( | prop, | |
| propName, | |||
| type | |||
| ) |
Register a NEW INDI property with the class, using the standard callback name.
Is a wrapper for MagAOXApp::registerIndiPropertyNew with setup
| prop | the property member name, with no quotes |
| propName | the property name, in quotes |
| type | the property type, pcf::IndiProperty::Type |
Definition at line 230 of file indiMacros.hpp.
| #define REG_INDI_NEWPROP_NOCB | ( | prop, | |
| propName, | |||
| type | |||
| ) |
Register a NEW INDI property with the class, with no callback.
Is a wrapper for MagAOXApp::registerIndiPropertyNew with NULL callback.
| 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 263 of file indiMacros.hpp.
| #define REG_INDI_NEWPROP_NOCB_DERIVED | ( | prop, | |
| propName, | |||
| type | |||
| ) |
Register a NEW INDI property with the class, with no callback, using the derived class.
Is a wrapper for MagAOXApp::registerIndiPropertyNew with NULL callback.
| 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 280 of file indiMacros.hpp.
| #define REG_INDI_NEWPROP_NOSETUP | ( | prop | ) |
Register a NEW INDI property with the class, using the standard callback name.
Is a wrapper for MagAOXApp::registerIndiPropertyNew with no setup
| prop | the property member name, with no quotes |
| propName | the property name, in quotes |
Definition at line 246 of file indiMacros.hpp.
| #define REG_INDI_SETPROP | ( | prop, | |
| devName, | |||
| propName | |||
| ) |
Register a SET INDI property with the class, using the standard callback name.
Is a wrapper for MagAOXApp::registerIndiPropertySet.
| 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 297 of file indiMacros.hpp.
| #define SET_INDI_NEWCALLBACK | ( | class, | |
| prop | |||
| ) |
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.
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 22 of file indiMacros.hpp.
| #define SET_INDI_SETCALLBACK | ( | class, | |
| prop | |||
| ) |
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.
| class | the class name (with no ") |
| prop | the property member name (with no ") |
Definition at line 35 of file indiMacros.hpp.