JeVois  1.5
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
jevois::UserInterface Class Referenceabstract

#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  Type { Type::Hard, Type::USB, Type::Stdio }
 Enum for the interface type. More...
 

Public Member Functions

 UserInterface (std::string const &instance)
 Constructor. More...
 
virtual ~UserInterface ()
 Destructor. More...
 
virtual bool readSome (std::string &str)=0
 Read some bytes if available, and return true and a string when one is complete (RETURN pressed) More...
 
virtual void writeString (std::string const &str)=0
 Write a string. More...
 
virtual Type type () const =0
 Derived classes must implement this and return their interface type. More...
 
- Public Member Functions inherited from jevois::Component
 Component (std::string const &instance)
 Constructor. More...
 
virtual ~Component ()
 Virtual destructor for safe inheritance. More...
 
template<>
std::shared_ptr< ComponentgetSubComponent (std::string const &instance) const
 
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. More...
 
template<class Comp >
void removeSubComponent (std::shared_ptr< Comp > &component)
 Remove a sub-Component from this Component, by shared_ptr. More...
 
void removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
 Remove a sub-Component from this Component, by instance name. More...
 
template<class Comp = jevois::Component>
std::shared_ptr< Comp > getSubComponent (std::string const &instance) const
 Get a sub-component by instance name. More...
 
bool isTopLevel () const
 Returns true if this component is top-level, i.e., its parent is jevois::Manager. More...
 
bool initialized () const
 Has this component been initialized yet? More...
 
std::string const & className () const
 The class name of this component. More...
 
std::string const & instanceName () const
 The instance name of this component. More...
 
template<typename T >
std::vector< std::string > setParamVal (std::string const &paramdescriptor, T const &val)
 Set a parameter value. More...
 
template<typename T >
void setParamValUnique (std::string const &paramdescriptor, T const &val)
 Set a parameter value, simple version assuming only one parameter match. More...
 
template<typename T >
std::vector< std::pair< std::string, T > > getParamVal (std::string const &paramdescriptor) const
 Get parameter(s) value(s) by descriptor. More...
 
template<typename T >
getParamValUnique (std::string const &paramdescriptor) const
 Get a parameter value, simple version assuming only one parameter match. More...
 
std::vector< std::string > setParamString (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value, by string. More...
 
void setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value by string, simple version assuming only one parameter match. More...
 
std::vector< std::pair< std::string, std::string > > getParamString (std::string const &paramdescriptor) const
 Get a parameter value, by string. More...
 
std::string getParamStringUnique (std::string const &paramdescriptor) const
 Get a parameter value by string, simple version assuming only one parameter match. More...
 
void freezeParam (std::string const &paramdescriptor)
 Freeze a parameter, by name, see ParameterBase::freeze() More...
 
void unFreezeParam (std::string const &paramdescriptor)
 Unfreeze a parameter, by name, see ParameterBase::unFreeze() More...
 
void freezeAllParams ()
 Freeze all parameters. More...
 
void unFreezeAllParams ()
 Unfreeze all parameters. More...
 
std::string descriptor () const
 Get our full descriptor (including all parents) as [Instancename]:[...]:[...]. More...
 
void setParamsFromFile (std::string const &filename)
 Set some parameters from a file. More...
 
std::istream & setParamsFromStream (std::istream &is, std::string const &absfile)
 Set some parameters from an open stream. More...
 
void setPath (std::string const &path)
 Assign a filesystem path to this component. More...
 
std::string absolutePath (std::string const &path="")
 If given path is relative (not starting with /), prepend the Component path to it. More...
 
- Public Member Functions inherited from jevois::ParameterRegistry
virtual ~ParameterRegistry ()
 Virtual destructor for safe inheritance. More...
 

Additional Inherited Members

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

Member Enumeration Documentation

◆ Type

Enum for the interface type.

Enumerator
Hard 
USB 
Stdio 

Definition at line 53 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, and jevois::StdioInterface.

◆ type()

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

Derived classes must implement this and return their interface type.

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

◆ writeString()

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, and jevois::StdioInterface.


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