cherrypi::MicroAction Struct Reference

Represents a decision of how to control a unit. More...

#include <upc.h>

Public Member Functions
std::shared_ptr< UPCTuple >	getFinalUPC () const
	if (isFinal): More...

Public Attributes
bool	isFinal = false
	If true: More...
std::shared_ptr< UPCTuple >	upc = nullptr
	if (isFinal): More...

Detailed Description

Represents a decision of how to control a unit.

Member Function Documentation

std::shared_ptr<UPCTuple> cherrypi::MicroAction::getFinalUPC ( ) const

inline

if (isFinal):

• Returns the UPC, which may be null.

if (!isFinal):

• The UPC doesn't matter; returns null.

Member Data Documentation

bool cherrypi::MicroAction::isFinal = false

If true:

• This MicroAction's UPC is the final decision on what command to issue this unit. If the UPC is null, the decision is to issue no command.

If false:

• This MicroAction represents the absence of a decision on what a unit should do. Allow downstream entities to make a decision of what to do.

std::shared_ptr<UPCTuple> cherrypi::MicroAction::upc = nullptr

if (isFinal):

• This UPC is the final decision on what this unit should do.

if (!isFinal):

• This UPC should be ignored.

---

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

• src/upc.h