JeVois  1.16
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
jevois::GUIconsole Class Reference

#include <jevois/GPU/GUIconsole.H>

Simple console with coloring and completion.

Definition at line 31 of file GUIconsole.H.

Inheritance diagram for jevois::GUIconsole:
Collaboration diagram for jevois::GUIconsole:

Public Member Functions

 GUIconsole (std::string const &instance)
 Constructor. More...
 
virtual ~GUIconsole ()
 Destructor. More...
 
bool readSome (std::string &str) override
 Read some bytes if available, and return true and a string when one is complete (RETURN pressed) More...
 
void writeString (std::string const &str) override
 Write a string. More...
 
Type type () const override
 Our type is: GUI. More...
 
void draw ()
 Render into ImGui. More...
 
int callback (ImGuiInputTextCallbackData *data)
 
- Public Member Functions inherited from jevois::UserInterface
 UserInterface (std::string const &instance)
 Constructor. More...
 
virtual ~UserInterface ()
 Destructor. More...
 
virtual void writeString (std::string const &prefix, std::string const &str)
 Write a string, with a prefix prepended. More...
 
- Public Member Functions inherited from jevois::Component
 Component (std::string const &instance)
 Constructor. More...
 
virtual ~Component ()
 Virtual destructor for safe inheritance. More...
 
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...
 
Engineengine () const
 Get a handle to our Engine, or throw if we do not have an Engine as root ancestor. More...
 
bool initialized () const
 Has this component been initialized yet? More...
 
const std::string & className () const
 The class name of this component. More...
 
const std::string & 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...
 
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. More...
 
void foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
 Run a function on every param we hold. 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...
 

Protected Member Functions

void clear ()
 Clear the contents of the window. More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from jevois::UserInterface
enum  Type { Type::Hard, Type::USB, Type::Stdio, Type::GUI }
 Enum for the interface type. More...
 

Constructor & Destructor Documentation

◆ GUIconsole()

jevois::GUIconsole::GUIconsole ( std::string const &  instance)

Constructor.

Definition at line 26 of file GUIconsole.C.

◆ ~GUIconsole()

jevois::GUIconsole::~GUIconsole ( )
virtual

Destructor.

Definition at line 40 of file GUIconsole.C.

Member Function Documentation

◆ callback()

int jevois::GUIconsole::callback ( ImGuiInputTextCallbackData *  data)

Definition at line 167 of file GUIconsole.C.

◆ clear()

void jevois::GUIconsole::clear ( )
protected

Clear the contents of the window.

Definition at line 48 of file GUIconsole.C.

◆ draw()

void jevois::GUIconsole::draw ( )

Render into ImGui.

Definition at line 84 of file GUIconsole.C.

References jevois::stringStartsWith().

Referenced by jevois::GUIhelper::drawConsole().

◆ readSome()

bool jevois::GUIconsole::readSome ( std::string &  str)
overridevirtual

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.

Implements jevois::UserInterface.

Definition at line 55 of file GUIconsole.C.

◆ type()

jevois::UserInterface::Type jevois::GUIconsole::type ( ) const
overridevirtual

Our type is: GUI.

Implements jevois::UserInterface.

Definition at line 44 of file GUIconsole.C.

References jevois::UserInterface::GUI.

◆ writeString()

void jevois::GUIconsole::writeString ( std::string const &  str)
overridevirtual

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).

Implements jevois::UserInterface.

Definition at line 69 of file GUIconsole.C.


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