jevois::UserInterface Class Reference

#include <jevois/Core/UserInterface.H>

Abstract base class for a string-based user interface.

Users interact with the JeVois hardware by issuing text commands and receiving text answers. UserInterface is an abstract base class for such communications, with derived classes Serial (on the platform hardware, using hardware serial and serial-over-usb) or StdioInterface (on host, using user inputs and outputs in the terminal).

See Command-line interface user guide for the user documentation of the command-line interface.

Definition at line 32 of file UserInterface.H.

Inheritance diagram for jevois::UserInterface:

Collaboration diagram for jevois::UserInterface:

Public Types
enum class	Type { Hard , USB , Stdio , GUI }
	Enum for the interface type. More...

Public Member Functions
	UserInterface (std::string const &instance)
	Constructor.
virtual	~UserInterface ()
	Destructor.
virtual bool	readSome (std::string &str)=0
	Read some bytes if available, and return true and a string when one is complete (RETURN pressed)
virtual void	writeString (std::string const &str)=0
	Write a string.
virtual void	writeString (std::string const &prefix, std::string const &str)
	Write a string, with a prefix prepended.
virtual Type	type () const =0
	Derived classes must implement this and return their interface type.
Public Member Functions inherited from jevois::Component
	Component (std::string const &instance)
	Constructor.
virtual	~Component ()
	Virtual destructor for safe inheritance.
template<class Comp , typename... Args>
std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)
	Pseudo-constructor: construct and add another component as a subcomponent of this one.
template<class Comp >
void	removeSubComponent (std::shared_ptr< Comp > &component)
	Remove a sub-Component from this Component, by shared_ptr.
void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
	Remove a sub-Component from this Component, by instance name.
template<class Comp = jevois::Component>
std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const
	Get a sub-component by instance name.
bool	isTopLevel () const
	Returns true if this component is top-level, i.e., its parent is jevois::Manager.
bool	initialized () const
	Has this component been initialized yet?
std::string const &	className () const
	The class name of this component.
std::string const &	instanceName () const
	The instance name of this component.
template<typename T >
std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)
	Set a parameter value.
template<typename T >
void	setParamValUnique (std::string const &paramdescriptor, T const &val)
	Set a parameter value, simple version assuming only one parameter match.
template<typename T >
std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const
	Get parameter(s) value(s) by descriptor.
template<typename T >
T	getParamValUnique (std::string const &paramdescriptor) const
	Get a parameter value, simple version assuming only one parameter match.
std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)
	Set a parameter value, by string.
void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
	Set a parameter value by string, simple version assuming only one parameter match.
std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const
	Get a parameter value, by string.
std::string	getParamStringUnique (std::string const &paramdescriptor) const
	Get a parameter value by string, simple version assuming only one parameter match.
void	freezeParam (std::string const &paramdescriptor, bool doit)
	Freeze/unfreeze a parameter, by name, see ParameterBase::freeze()
void	freezeAllParams (bool doit)
	Freeze all parameters.
std::string	descriptor () const
	Get our full descriptor (including all parents) as [Instancename]:[...]:[...].
void	setParamsFromFile (std::string const &filename)
	Set some parameters from a file.
std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)
	Set some parameters from an open stream.
virtual void	paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
	Get machine-oriented descriptions of all parameters.
void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
	Run a function on every param we hold.
template<typename T >
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
	Add a new parameter after the Component has already been constructed.
template<typename T , template< typename > class ValidValuesSpec>
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
	Add a new parameter after the Component has already been constructed.
template<typename T >
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
	Register a callback with a previously created dynamic parameter.
void	removeDynamicParameter (std::string const &name, bool throw_if_not_found=true)
	Remove a previously added dynamic parameter.
void	setPath (std::string const &path)
	Assign a filesystem path to this component.
std::filesystem::path	absolutePath (std::filesystem::path const &path="")
	If given path is relative (not starting with /), prepend the Component path to it.
Public Member Functions inherited from jevois::ParameterRegistry
virtual	~ParameterRegistry ()
	Virtual destructor for safe inheritance.

Additional Inherited Members
Protected Member Functions inherited from jevois::Component
virtual void	preInit ()
	Called before all sub-Components are init()ed.
virtual void	postInit ()
	Called after all sub-Components are init()ed.
virtual void	preUninit ()
	Called before all sub-Components are uninit()ed.
virtual void	postUninit ()
	Called after all sub-Components are uninit()ed.
Protected Member Functions inherited from jevois::ParameterRegistry
void	addParameter (ParameterBase *const param)
	The Parameter class uses this method to register itself on construction with its owning Component.
void	removeParameter (ParameterBase *const param)
	The Parameter class uses this method to un-register itself on destruction with its owning Component.
void	callbackInitCall ()
	For all parameters that have a callback which has never been called, call it with the default param value.

Member Enumeration Documentation

Type

enum class jevois::UserInterface::Type

strong

Enum for the interface type.

Enumerator
Hard
USB
Stdio
GUI

Definition at line 59 of file UserInterface.H.

Constructor & Destructor Documentation

UserInterface()

jevois::UserInterface::UserInterface

(

std::string const &

instance

)

Constructor.

Definition at line 21 of file UserInterface.C.

~UserInterface()

jevois::UserInterface::~UserInterface ( )

virtual

Destructor.

Definition at line 26 of file UserInterface.C.

Member Function Documentation

readSome()

virtual bool jevois::UserInterface::readSome ( std::string &  str )

pure virtual

Read some bytes if available, and return true and a string when one is complete (RETURN pressed)

str is untouched if user input is not yet complete (RETURN not yet pressed). The RETURN (end of line) marker is not copied into str, only the characters received up to the end of line marker.

Implemented in jevois::Serial, jevois::StdioInterface, jevois::GUIconsole, and jevois::GUIserial.

type()

virtual Type jevois::UserInterface::type ( ) const

pure virtual

Derived classes must implement this and return their interface type.

Implemented in jevois::Serial, jevois::StdioInterface, and jevois::GUIconsole.

writeString() [1/2]

void jevois::UserInterface::writeString ( std::string const &  prefix, std::string const &  str  )

virtual

Write a string, with a prefix prepended.

No line terminator should be included in the string, writeString() will add one. In the Serial derived class, this will be using the line termination convention of serial::linestyle to support different styles (CR, CRLF, LF, etc).

Definition at line 30 of file UserInterface.C.

writeString() [2/2]

virtual void jevois::UserInterface::writeString ( std::string const &  str )

pure virtual

Write a string.

No line terminator should be included in the string, writeString() will add one. In the Serial derived class, this will be using the line termination convention of serial::linestyle to support different styles (CR, CRLF, LF, etc).

Implemented in jevois::Serial, jevois::StdioInterface, jevois::GUIconsole, and jevois::GUIserial.

---

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

• include/jevois/Core/UserInterface.H
• src/jevois/Core/UserInterface.C