Passer::RoboidControl::Switch Class Reference

A digital switch input. More...

#include <Switch.h>

Inheritance diagram for Passer::RoboidControl::Switch:

Public Member Functions
	Switch ()
	Default constructor.
virtual bool	IsOn ()
	Test of the switch is on.
virtual bool	IsOff ()
virtual void	Update ()
bool	IsMotor ()
	Check if the Thing is a Motor.
bool	IsSensor ()
	Check if the Thing is a Sensor.
void	SetParent (Thing *parent)
Thing *	GetParent ()
void	AddChild (Thing *child)
Thing *	GetChild (unsigned char childIx)

Public Attributes
unsigned int	type
	The type of Thing.
Polar	position

Static Public Attributes
static const unsigned int	SwitchType = SensorType | (unsigned int)Type::Switch
	The type of a switch sensor.
static const unsigned int	DistanceSensorType
	The type of a distance sensor.
static const unsigned int	ControlledMotorType
	The type of a controlled motor.
static const unsigned int	UncontrolledMotorType
	The type of an uncontrolled motor.
static const unsigned int	ServoType = (unsigned int)Type::Servo
	The type of an object received from the network.
static const unsigned int	ExternalType = (unsigned int)Type::ExternalSensor

Protected Types
enum class	Type {   Undetermined , Switch , DistanceSensor , ControlledMotor ,   UncontrolledMotor , Servo , ExternalSensor }
	Basic Thing types. More...

Protected Attributes
Thing *	parent = nullptr
unsigned char	childCount = 0
Thing **	children = nullptr

Static Protected Attributes
static const unsigned int	MotorType = 0x8000
	Bitmask for Motor type.
static const unsigned int	SensorType = 0x4000
	Bitmap for Sensor type.

Detailed Description

A digital switch input.

Member Enumeration Documentation

Type

enum class Passer::RoboidControl::Thing::Type

strongprotectedinherited

Basic Thing types.

Enumerator
Undetermined
Switch
DistanceSensor
ControlledMotor
UncontrolledMotor
Servo
ExternalSensor

Constructor & Destructor Documentation

Switch()

Switch::Switch

(

)

Default constructor.

Member Function Documentation

IsOn()

bool Switch::IsOn ( )

virtual

Test of the switch is on.

Returns

true when the switch returns a HIGH value

IsOff()

bool Switch::IsOff ( )

virtual

Update()

virtual void Passer::RoboidControl::Sensor::Update ( )

inlinevirtualinherited

IsMotor()

bool Thing::IsMotor ( )

inherited

Check if the Thing is a Motor.

Returns

True when the Thing is a Motor and False otherwise

IsSensor()

bool Thing::IsSensor ( )

inherited

Check if the Thing is a Sensor.

Returns

True when the Thing is a Sensor and False otherwise

SetParent()

void Thing::SetParent ( Thing *  parent )

inherited

GetParent()

Thing * Thing::GetParent ( )

inherited

AddChild()

void Thing::AddChild ( Thing *  child )

inherited

GetChild()

Thing * Thing::GetChild ( unsigned char  childIx )

inherited

Member Data Documentation

type

unsigned int Passer::RoboidControl::Thing::type

inherited

The type of Thing.

SwitchType

const unsigned int Thing::SwitchType = SensorType | (unsigned int)Type::Switch

staticinherited

The type of a switch sensor.

DistanceSensorType

const unsigned int Thing::DistanceSensorType

staticinherited

Initial value:

=
    SensorType | (unsigned int)Type::DistanceSensor

The type of a distance sensor.

ControlledMotorType

const unsigned int Thing::ControlledMotorType

staticinherited

Initial value:

=
    MotorType | (unsigned int)Type::ControlledMotor

The type of a controlled motor.

UncontrolledMotorType

const unsigned int Thing::UncontrolledMotorType

staticinherited

Initial value:

=
    MotorType | (unsigned int)Type::UncontrolledMotor

The type of an uncontrolled motor.

ServoType

const unsigned int Thing::ServoType = (unsigned int)Type::Servo

staticinherited

The type of an object received from the network.

ExternalType

const unsigned int Thing::ExternalType = (unsigned int)Type::ExternalSensor

staticinherited

position

Polar Passer::RoboidControl::Thing::position

inherited

MotorType

const unsigned int Passer::RoboidControl::Thing::MotorType = 0x8000

staticprotectedinherited

Bitmask for Motor type.

SensorType

const unsigned int Passer::RoboidControl::Thing::SensorType = 0x4000

staticprotectedinherited

Bitmap for Sensor type.

parent

Thing* Passer::RoboidControl::Thing::parent = nullptr

protectedinherited

childCount

unsigned char Passer::RoboidControl::Thing::childCount = 0

protectedinherited

children

Thing** Passer::RoboidControl::Thing::children = nullptr

protectedinherited

---

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

• d:/PlatformIO/RoboidControl/Switch.h
• d:/PlatformIO/RoboidControl/Switch.cpp