iCub-main
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
iCub::learningmachine::TrainEventListener Class Reference

#include <TrainEventListener.h>

+ Inheritance diagram for iCub::learningmachine::TrainEventListener:

Public Member Functions

 TrainEventListener (std::string pp="/lm/event/train")
 Constructor.
 
void handle (TrainEvent &e)
 Handling of a TrainEvent.
 
TrainEventListenerclone ()
 Asks the event listener to return a new object of its type.
 
- Public Member Functions inherited from iCub::learningmachine::IPortEventListener
 IPortEventListener (std::string pp)
 Constructor.
 
 IPortEventListener (const IPortEventListener &other)
 Copy Constructor.
 
virtual ~IPortEventListener ()
 Destructor.
 
virtual IPortEventListeneroperator= (const IPortEventListener &other)
 Assignment operator.
 
virtual void start ()
 Starts the IEventListener.
 
virtual bool configure (yarp::os::Searchable &config)
 
virtual std::string getInfo ()
 Asks the event listener to return a string containing information on its configuration so far.
 
- Public Member Functions inherited from iCub::learningmachine::IEventListener
 IEventListener ()
 Constructor.
 
virtual ~IEventListener ()
 Destructor (empty).
 
virtual void handle (IEvent &e)
 Default handler for any Event, which means the Event is ignored.
 
virtual void handle (PredictEvent &e)
 Handling of a PredictEvent.
 
std::string getName () const
 Retrieve the name of this IEventListener.
 
void setName (std::string name)
 Set the name of this IEventListener.
 
virtual bool isEnabled ()
 Tells whether dispatching of events is enabled.
 
virtual void setEnabled (bool val)
 Enables or disables dispatching of events.
 

Protected Member Functions

void vectorToBottle (const yarp::sig::Vector &vec, yarp::os::Bottle &bot)
 
- Protected Member Functions inherited from iCub::learningmachine::IPortEventListener
void resetPort (std::string portName)
 Resets the port and opens it at the specified name.
 

Additional Inherited Members

- Protected Attributes inherited from iCub::learningmachine::IPortEventListener
yarp::os::Port port
 The outgoing port for the events.
 
bool verbose
 Verbosity controls whether events are printed to standard output.
 
std::string portPrefix
 A prefix path for the ports that will be registered.
 
- Protected Attributes inherited from iCub::learningmachine::IEventListener
std::string name
 The name of this type of EventListener.
 
bool enabled
 Boolean switch to disable or enable event the listener.
 

Detailed Description

See also
iCub::learningmachine::IEventListener
Author
Arjan Gijsberts

Definition at line 39 of file TrainEventListener.h.

Constructor & Destructor Documentation

◆ TrainEventListener()

iCub::learningmachine::TrainEventListener::TrainEventListener ( std::string  pp = "/lm/event/train")
inline

Constructor.

Parameters
ppdefault port prefix

Definition at line 53 of file TrainEventListener.h.

Member Function Documentation

◆ clone()

TrainEventListener * iCub::learningmachine::TrainEventListener::clone ( )
inlinevirtual

Asks the event listener to return a new object of its type.

Returns
a fresh instance of the current class

Implements iCub::learningmachine::IEventListener.

Definition at line 65 of file TrainEventListener.h.

◆ handle()

void iCub::learningmachine::TrainEventListener::handle ( TrainEvent e)
virtual

Handling of a TrainEvent.

Parameters
ethe TrainEvent

Reimplemented from iCub::learningmachine::IEventListener.

Definition at line 29 of file TrainEventListener.cpp.

◆ vectorToBottle()

void iCub::learningmachine::TrainEventListener::vectorToBottle ( const yarp::sig::Vector &  vec,
yarp::os::Bottle &  bot 
)
inlineprotected

Definition at line 41 of file TrainEventListener.h.


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