trax::BinaryIndicator Struct Reference

An Indicator with two states. More...

#include <C:/Trend/Development/Trax3/Code/trax/Indicator.h>

Inheritance diagram for trax::BinaryIndicator:

Public Member Functions
virtual Jack &	JackOnOne () noexcept=0
	Gets a Jack that pulses its Plug if the BinaryIndicator is set to one.
virtual Plug &	PlugToOne () noexcept=0
	Gets a Plug that sets the BinaryIndicator to one.
virtual Jack &	JackOnTwo () noexcept=0
	Gets a Jack that pulses its Plug if the BinaryIndicator is set to zero.
virtual Plug &	PlugToTwo () noexcept=0
	Gets a Plug that sets the BinaryIndicator to zero.
Public Member Functions inherited from trax::Indicator
virtual const char *	TypeName () const noexcept=0
virtual void	SetFrame (const spat::Frame< Length, One > &frame)=0
	Set frame of reference.
virtual const spat::Frame< Length, One > &	GetFrame () const =0
	Get frame of reference.
virtual void	Get (spat::Frame< Length, One > &frame) const =0
	Gets the pose of the Indicator in global coordinates.
virtual void	Toggle (bool pulse=true)=0
	Sets the indicator to the next setting.
virtual Status	Set (Status status, bool pulse=true)=0
	Turns the indicator to the specified setting.
virtual Status	Get () const =0
	Gets the setting of the indicator.
virtual bool	IsValidState (Status status) const =0
virtual void	RotateWithStatus (Status status, Real angle)=0
	Set an angle to rotate the indicator by with its status.
virtual Real	RotateWithStatus (Status status) const =0
virtual Jack &	JackOn (Status status)=0
	Gets a Jack that pulses its Plug if the specified Status is set.
virtual Plug &	PlugTo (Status status)=0
	Gets a Plug that switches to the specified Status.
virtual Plug &	PlugToToggle () noexcept=0
virtual Jack &	JackOnChange () noexcept=0
virtual void	RegisterSockets (SocketRegistry &registry)=0
	Registers all the Plugs with the module and supplies the Jacks with plug ids for connecting.
virtual void	UnregisterSockets (SocketRegistry &registry)=0
	Removes all references to Plugs and Jacks from the module.
Public Member Functions inherited from trax::Identified< Indicator >
virtual const std::string &	Reference (const std::string &name) const=0
	Gets a reference that was set for this object by name.
virtual const std::vector< char const * > &	ReferenceNames (const std::string &namePart) const=0
	Searches for all reference names that countain namePart as substring in the name.
virtual IDType	ID () const noexcept=0
	Identified (const Identified &)=delete
Identified &	operator= (const Identified &)=delete

Static Public Member Functions
static dclspc std::unique_ptr< BinaryIndicator >	Make (Type type) noexcept
	Makes a BinaryIndicator object.
Static Public Member Functions inherited from trax::Indicator
static dclspc std::unique_ptr< Indicator >	Make (Type type) noexcept
	Makes a Indicator object.

Additional Inherited Members
Public Types inherited from trax::Indicator
enum class	Type : char {   unknown = -1 , none = 0 , switch_mono , switch_multi ,   velocity_control }
enum class	Status {   none = -1 , unknown = 0 , one = 1 , two = 2 ,   three = 3 , four = 4 , five = 5 , six = 6 ,   seven = 7 , eight = 8 , nine = 9 , ten = 10 ,   eleven = 11 , twelve = 12 , thirteen = 13 , count ,   toggle , change }
	Possible Indicator states: More...

Detailed Description

An Indicator with two states.

---

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

• C:/Trend/Development/Trax3/Code/trax/Indicator.h