iCub-main
Public Member Functions | Protected Attributes | List of all members
iCub::learningmachine::PredictEvent Class Reference

#include <PredictEvent.h>

+ Inheritance diagram for iCub::learningmachine::PredictEvent:

Public Member Functions

 PredictEvent (const yarp::sig::Vector &input, const Prediction &predicted)
 Constructor. More...
 
virtual ~PredictEvent ()
 Destructor (empty). More...
 
virtual void visit (IEventListener &listener)
 Causes the Event to visit an EventListener. More...
 
virtual std::string toString ()
 Returns a string representation of the Event. More...
 
yarp::sig::Vector & getInput ()
 Accessor for the vector of inputs. More...
 
PredictiongetPredicted ()
 Accessor for the prediction. More...
 

Protected Attributes

yarp::sig::Vector input
 Vector of inputs. More...
 
Prediction predicted
 Vector of predicted outputs. More...
 

Detailed Description

Definition at line 45 of file PredictEvent.h.

Constructor & Destructor Documentation

◆ PredictEvent()

iCub::learningmachine::PredictEvent::PredictEvent ( const yarp::sig::Vector &  input,
const Prediction predicted 
)

Constructor.

Parameters
inputthe vector of inputs
predictedthe vector of predicted outputs

Definition at line 27 of file PredictEvent.cpp.

◆ ~PredictEvent()

virtual iCub::learningmachine::PredictEvent::~PredictEvent ( )
inlinevirtual

Destructor (empty).

Definition at line 69 of file PredictEvent.h.

Member Function Documentation

◆ getInput()

yarp::sig::Vector& iCub::learningmachine::PredictEvent::getInput ( )
inline

Accessor for the vector of inputs.

Returns
a reference to the registered vector of inputs

Definition at line 85 of file PredictEvent.h.

◆ getPredicted()

Prediction& iCub::learningmachine::PredictEvent::getPredicted ( )
inline

Accessor for the prediction.

Returns
a reference to the prediction

Definition at line 93 of file PredictEvent.h.

◆ toString()

std::string iCub::learningmachine::PredictEvent::toString ( )
virtual

Returns a string representation of the Event.

Returns
string the string representation

Implements iCub::learningmachine::IEvent.

Definition at line 36 of file PredictEvent.cpp.

◆ visit()

void iCub::learningmachine::PredictEvent::visit ( IEventListener listener)
virtual

Causes the Event to visit an EventListener.

This method is part of the double dispatch mechanism. Child classes need to override this function.

Parameters
listenerthe listener

Implements iCub::learningmachine::IEvent.

Definition at line 32 of file PredictEvent.cpp.

Member Data Documentation

◆ input

yarp::sig::Vector iCub::learningmachine::PredictEvent::input
protected

Vector of inputs.

Definition at line 50 of file PredictEvent.h.

◆ predicted

Prediction iCub::learningmachine::PredictEvent::predicted
protected

Vector of predicted outputs.

Definition at line 55 of file PredictEvent.h.


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