Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

ControlBase.h File Reference

Defines ControlBase from which all items in the control system should inherit. More...

#include "Motion/MotionManagerMsg.h"
#include <string>
#include <vector>
#include <map>
Include dependency graph for ControlBase.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  ControlBase
 Base class for all items in the Controller hierarchy. More...

Defines

#define AUTO_REGISTER_NAME_INDIRECT(className, line)   autoRegister ## className ## line
 Creates name token for the auto registration variable, have to do a layer of indirection to get line number into token so that a behavior can be registered in multiple menus.
#define AUTO_REGISTER_NAME(className, line)   AUTO_REGISTER_NAME_INDIRECT(className, line)
 Creates name token for the auto registration variable, have to do a layer of indirection to get line number into token so that a behavior can be registered in multiple menus.
#define REGISTER_CONTROL_INSTANCE_OPT(className, controlInstance, menu, flags)   const ControlBase* AUTO_REGISTER_NAME(className,__LINE__) = ControlBase::registerControllerEntry(controlInstance,menu,flags)
 Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL and REGISTER_BEHAVIOR for behaviors.
#define REGISTER_CONTROL_INSTANCE(className, controlInstance, menu)   REGISTER_CONTROL_INSTANCE_OPT(className, controlInstance, menu, ControlBase::DEFAULTS)
 Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL and REGISTER_BEHAVIOR for behaviors.
#define REGISTER_CONTROL_OPT(className, menu, flags)   REGISTER_CONTROL_INSTANCE_OPT(className, new className, menu, flags)
 Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL_INSTANCE and REGISTER_BEHAVIOR for behaviors.
#define REGISTER_CONTROL(className, menu)   REGISTER_CONTROL_INSTANCE(className, new className, menu)
 Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL_INSTANCE and REGISTER_BEHAVIOR for behaviors.

Detailed Description

Defines ControlBase from which all items in the control system should inherit.

Author:
ejt (Creator)

Definition in file ControlBase.h.


Define Documentation

#define AUTO_REGISTER_NAME ( className,
line   )     AUTO_REGISTER_NAME_INDIRECT(className, line)

Creates name token for the auto registration variable, have to do a layer of indirection to get line number into token so that a behavior can be registered in multiple menus.

Definition at line 14 of file ControlBase.h.

#define AUTO_REGISTER_NAME_INDIRECT ( className,
line   )     autoRegister ## className ## line

Creates name token for the auto registration variable, have to do a layer of indirection to get line number into token so that a behavior can be registered in multiple menus.

Definition at line 12 of file ControlBase.h.

#define REGISTER_CONTROL ( className,
menu   )     REGISTER_CONTROL_INSTANCE(className, new className, menu)

Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL_INSTANCE and REGISTER_BEHAVIOR for behaviors.

Specify the menu name (use '/' to demark submenus).

Definition at line 31 of file ControlBase.h.

#define REGISTER_CONTROL_INSTANCE ( className,
controlInstance,
menu   )     REGISTER_CONTROL_INSTANCE_OPT(className, controlInstance, menu, ControlBase::DEFAULTS)

Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL and REGISTER_BEHAVIOR for behaviors.

Specify the menu name (use '/' to demark submenus)

Definition at line 23 of file ControlBase.h.

#define REGISTER_CONTROL_INSTANCE_OPT ( className,
controlInstance,
menu,
flags   )     const ControlBase* AUTO_REGISTER_NAME(className,__LINE__) = ControlBase::registerControllerEntry(controlInstance,menu,flags)

Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL and REGISTER_BEHAVIOR for behaviors.

Specify the menu name (use '/' to demark submenus) and allows you to pass optional flags

Definition at line 18 of file ControlBase.h.

#define REGISTER_CONTROL_OPT ( className,
menu,
flags   )     REGISTER_CONTROL_INSTANCE_OPT(className, new className, menu, flags)

Should be called in the global namespace of a translation unit (i.e. a '.cc' file) in order to register a control in the controller menu system. See also REGISTER_CONTROL_INSTANCE and REGISTER_BEHAVIOR for behaviors.

Specify the menu name (use '/' to demark submenus) and allows you to pass optional flags.

Definition at line 27 of file ControlBase.h.


Tekkotsu v5.1CVS
Generated Mon May 9 04:58:55 2016 by Doxygen 1.6.3