VizBlocks
Public Member Functions | Protected Attributes | List of all members
Behaviour Class Reference

#include <Behaviours.hpp>

Inheritance diagram for Behaviour:
BreathingLEDs BrightnessLEDs ButtonClicked ButtonHeld ButtonPressed ButtonTick Link NumLEDs PingServer PotentiometerUpdated RotaryEncoderUpdated SendCapabilities ServoGoto ServoRotateReturn ServoWiggle TestBehaviour

Public Member Functions

 Behaviour (String name)
 
 ~Behaviour ()
 
virtual boolean is_interruptable ()
 
virtual boolean is_temp ()
 
virtual boolean is_priority ()
 
virtual boolean is_running ()
 
virtual boolean is_background ()
 
virtual String name ()
 
virtual char * args ()
 
virtual String start (String args)
 
virtual void update ()
 
virtual void stop ()
 

Protected Attributes

boolean _interruptable = true
 
boolean _temp = false
 
boolean _priority = false
 
boolean _running = false
 
boolean _background = false
 
String _name = "name"
 

Detailed Description

[Behaviour description]

Parameters
name[description]

Constructor & Destructor Documentation

◆ Behaviour()

Behaviour::Behaviour ( String  name)

◆ ~Behaviour()

Behaviour::~Behaviour ( )

Member Function Documentation

◆ args()

virtual char* Behaviour::args ( )
virtual

What arguments does the behaviour take? Override this to document your behaviour

Reimplemented in ButtonClicked, ButtonTick, ServoRotateReturn, Link, BreathingLEDs, ServoWiggle, BrightnessLEDs, PotentiometerUpdated, ServoGoto, and NumLEDs.

◆ is_background()

virtual boolean Behaviour::is_background ( )
virtual

What's the name of this behaviour

◆ is_interruptable()

virtual boolean Behaviour::is_interruptable ( )
virtual

Can this behaviour be interruped

◆ is_priority()

virtual boolean Behaviour::is_priority ( )
virtual

Should this behaviour override others

◆ is_running()

virtual boolean Behaviour::is_running ( )
virtual

Is the behaviour running

◆ is_temp()

virtual boolean Behaviour::is_temp ( )
virtual

Can this behaviour be run quickly without stopping what's going on (e.g. comms, debug)

◆ name()

virtual String Behaviour::name ( )
virtual

What's the name of this behaviour

◆ start()

virtual String Behaviour::start ( String  args)
virtual

Start the behaviour, with arguments (don't know why this can't be virtual?)

Reimplemented in PingServer, ButtonTick, ButtonHeld, ServoRotateReturn, TestBehaviour, Link, BreathingLEDs, ServoWiggle, PotentiometerUpdated, RotaryEncoderUpdated, SendCapabilities, ServoGoto, ButtonPressed, and NumLEDs.

◆ stop()

virtual void Behaviour::stop ( )
virtual

Start the behaviour, with arguments (don't know why this can't be virtual?)

◆ update()

virtual void Behaviour::update ( )
virtual

Update the behaviour periodically

Reimplemented in PingServer, Link, ServoRotateReturn, BreathingLEDs, and ServoWiggle.

Member Data Documentation

◆ _background

boolean Behaviour::_background = false
protected

◆ _interruptable

boolean Behaviour::_interruptable = true
protected

◆ _name

String Behaviour::_name = "name"
protected

◆ _priority

boolean Behaviour::_priority = false
protected

◆ _running

boolean Behaviour::_running = false
protected

◆ _temp

boolean Behaviour::_temp = false
protected

The documentation for this class was generated from the following file: