Roboid Control for C++ 0.4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
RoboidControl::Arduino::DigitalInput Class Reference

Detailed Description

A digital input represents the stat of a digital GPIO pin.

#include <DigitalInput.h>

Inheritance diagram for RoboidControl::Arduino::DigitalInput:
RoboidControl::Thing

Public Member Functions

 DigitalInput (unsigned char pin, Thing *parent)
 Create a new digital input.
 
virtual void Update (bool recursive=false) override
 
void SetName (const char *name)
 
const char * GetName () const
 
void SetModel (const char *url)
 Sets the location from where the 3D model of this Thing can be loaded from.
 
void SetParent (Thing *parent)
 Sets the parent of this Thing.
 
ThingGetParent ()
 Gets the parent of this Thing.
 
bool IsRoot () const
 Check if this is a root thing.
 
ThingGetChildByIndex (unsigned char ix)
 Get a child by index.
 
virtual void AddChild (Thing *child)
 Add a child Thing to this Thing.
 
ThingRemoveChild (Thing *child)
 Remove the given thing as a child of this thing.
 
ThingGetChild (unsigned char id, bool recurse=false)
 Get a child by thing Id.
 
ThingFindChild (const char *name, bool recurse=true)
 Find a thing by name.
 
void SetPosition (Spherical position)
 Set the position of the thing.
 
Spherical GetPosition ()
 Get the position of the thing.
 
void SetOrientation (SwingTwist orientation)
 Set the orientation of the thing.
 
SwingTwist GetOrientation ()
 Get the orientation of the thing.
 
void SetLinearVelocity (Spherical linearVelocity)
 Set the linear velocity of the thing.
 
virtual Spherical GetLinearVelocity ()
 Get the linear velocity of the thing.
 
virtual void SetAngularVelocity (Spherical angularVelocity)
 Set the angular velocity of the thing.
 
virtual Spherical GetAngularVelocity ()
 Get the angular velocity of the thing.
 
virtual void PrepareForUpdate ()
 
virtual int GenerateBinary (char *buffer, unsigned char *ix)
 Function used to generate binary data for this thing.
 
virtual void ProcessBinary (char *bytes)
 Function used to process binary data received for this thing.
 

Static Public Member Functions

static void CreateRoot (Participant *owner)
 Create a root thing for a participant.
 
static ThingLocalRoot ()
 The root thing for the local participant.
 
static unsigned long GetTimeMs ()
 Get the current time in milliseconds.
 

Public Attributes

bool isHigh = false
 
bool isLow = false
 
bool terminate = false
 Terminated things are no longer updated.
 
unsigned char id = 0
 The ID of the thing.
 
unsigned char type = Type::Undetermined
 The type of Thing This can be either a Thing::Type of a byte value for custom types.
 
Participantowner = nullptr
 The participant owning this thing.
 
const char * name = nullptr
 The name of the thing.
 
bool nameChanged = false
 
const char * modelUrl = nullptr
 An URL pointing to the location where a model of the thing can be found.
 
unsigned char childCount = 0
 The number of children.
 
bool hierarchyChanged = true
 Indicator that the hierarchy of the thing has changed.
 
bool positionUpdated = false
 Boolean indicating that the thing has an updated position.
 
bool orientationUpdated = false
 Boolean indicating the thing has an updated orientation.
 
bool linearVelocityUpdated = false
 Boolean indicating the thing has an updated linear velocity.
 
bool angularVelocityUpdated = false
 Boolean indicating the thing has an updated angular velocity.
 

Protected Attributes

unsigned char pin = 0
 The pin used for digital input.
 

Constructor & Destructor Documentation

◆ DigitalInput()

RoboidControl::Arduino::DigitalInput::DigitalInput ( unsigned char  pin,
Thing parent 
)

Create a new digital input.

Parameters
participantThe participant to use
pinThe digital pin

Member Function Documentation

◆ Update()

void RoboidControl::Arduino::DigitalInput::Update ( bool  recursive = false)
overridevirtual

Reimplemented from RoboidControl::Thing.

◆ CreateRoot()

void RoboidControl::Thing::CreateRoot ( Participant owner)
staticinherited

Create a root thing for a participant.

Parameters
ownerThe participant who will own this root thing

◆ LocalRoot()

Thing * RoboidControl::Thing::LocalRoot ( )
staticinherited

The root thing for the local participant.

Returns
The root thing for the local participant

◆ SetModel()

void RoboidControl::Thing::SetModel ( const char *  url)
inherited

Sets the location from where the 3D model of this Thing can be loaded from.

Parameters
urlThe url of the model
Remarks
Although the roboid implementation is not dependent on the model, the only official supported model formats are .png (sprite), .gltf and .glb

◆ SetParent()

void RoboidControl::Thing::SetParent ( Thing parent)
inherited

Sets the parent of this Thing.

Parameters
parentThe Thing which should become the parent

◆ GetParent()

Thing * RoboidControl::Thing::GetParent ( )
inherited

Gets the parent of this Thing.

Returns
The parent Thing

◆ IsRoot()

bool RoboidControl::Thing::IsRoot ( ) const
inherited

Check if this is a root thing.

Returns
True is this thing is a root

◆ GetChildByIndex()

Thing * RoboidControl::Thing::GetChildByIndex ( unsigned char  ix)
inherited

Get a child by index.

Parameters
ixThe child index
Returns
The found thing of nullptr when nothing is found

◆ AddChild()

void RoboidControl::Thing::AddChild ( Thing child)
virtualinherited

Add a child Thing to this Thing.

Parameters
childThe Thing which should become a child
Remarks
When the Thing is already a child, it will not be added again

◆ RemoveChild()

Thing * RoboidControl::Thing::RemoveChild ( Thing child)
inherited

Remove the given thing as a child of this thing.

Parameters
childThe child to remove
Returns
The removed child or nullptr if the child could not be found

◆ GetChild()

Thing * RoboidControl::Thing::GetChild ( unsigned char  id,
bool  recurse = false 
)
inherited

Get a child by thing Id.

Parameters
idThe thing ID to find
recurseLook recursively through all descendants
Returns
The found thing of nullptr when nothing is found

◆ FindChild()

Thing * RoboidControl::Thing::FindChild ( const char *  name,
bool  recurse = true 
)
inherited

Find a thing by name.

Parameters
nameThe name of the thing
recurseLook recursively through all descendants
Returns
The found thing or nullptr when nothing is found

◆ SetPosition()

void RoboidControl::Thing::SetPosition ( Spherical  position)
inherited

Set the position of the thing.

Parameters
positionThe new position in local space, in meters

◆ GetPosition()

Spherical RoboidControl::Thing::GetPosition ( )
inherited

Get the position of the thing.

Returns
The position in local space, in meters

◆ SetOrientation()

void RoboidControl::Thing::SetOrientation ( SwingTwist  orientation)
inherited

Set the orientation of the thing.

Parameters
orientationThe new orientation in local space

◆ GetOrientation()

SwingTwist RoboidControl::Thing::GetOrientation ( )
inherited

Get the orientation of the thing.

Returns
The orienation in local space

◆ SetLinearVelocity()

void RoboidControl::Thing::SetLinearVelocity ( Spherical  linearVelocity)
inherited

Set the linear velocity of the thing.

Parameters
linearVelocityThe new linear velocity in local space, in meters per second

◆ GetLinearVelocity()

Spherical RoboidControl::Thing::GetLinearVelocity ( )
virtualinherited

Get the linear velocity of the thing.

Returns
The linear velocity in local space, in meters per second

◆ SetAngularVelocity()

void RoboidControl::Thing::SetAngularVelocity ( Spherical  angularVelocity)
virtualinherited

Set the angular velocity of the thing.

Parameters
angularVelocitythe new angular velocity in local space

◆ GetAngularVelocity()

Spherical RoboidControl::Thing::GetAngularVelocity ( )
virtualinherited

Get the angular velocity of the thing.

Returns
The angular velocity in local space

◆ GetTimeMs()

unsigned long RoboidControl::Thing::GetTimeMs ( )
staticinherited

Get the current time in milliseconds.

Returns
The current time in milliseconds

◆ GenerateBinary()

int RoboidControl::Thing::GenerateBinary ( char *  buffer,
unsigned char *  ix 
)
virtualinherited

Function used to generate binary data for this thing.

Parameters
bufferThe byte array for thw binary data
ixThe starting position for writing the binary data
Returns
The size of the binary data

Reimplemented in RoboidControl::DifferentialDrive, RoboidControl::DigitalSensor, RoboidControl::RelativeEncoder, RoboidControl::TemperatureSensor, and RoboidControl::TouchSensor.

◆ ProcessBinary()

void RoboidControl::Thing::ProcessBinary ( char *  bytes)
virtualinherited

Function used to process binary data received for this thing.

Parameters
bytesThe binary data

Reimplemented in RoboidControl::DigitalSensor, RoboidControl::RelativeEncoder, RoboidControl::TemperatureSensor, and RoboidControl::TouchSensor.