agent_model::Interface Class Reference

The agent model interface. The class implements the data structure of the agent model, consisting of input, state, memory and parameters. More...

#include <Interface.h>

Inheritance diagram for agent_model::Interface:

Collaboration diagram for agent_model::Interface:

Public Types
typedef agent_model::Input	Input
typedef agent_model::State	State
typedef agent_model::Memory	Memory
typedef agent_model::Parameters	Parameters

Public Member Functions
	Interface ()=default
virtual	~Interface ()=default
Input *	getInput ()
const Input *	getInput () const
State *	getState ()
const State *	getState () const
Memory *	getMemory ()
const Memory *	getMemory () const
Parameters *	getParameters ()
const Parameters *	getParameters () const

Protected Attributes
Input	_input {}
	The input of the agent model.
State	_state {}
	The state of the agent model.
Memory	_memory {}
	The memory of the agent model.
Parameters	_param {}
	The parameters of the agent model.

Detailed Description

The agent model interface. The class implements the data structure of the agent model, consisting of input, state, memory and parameters.

Constructor & Destructor Documentation

Interface()

agent_model::Interface::Interface ( )

default

Default constructor

~Interface()

virtual agent_model::Interface::~Interface ( )

virtualdefault

Default destructor

Member Function Documentation

getInput() [1/2]

Input* agent_model::Interface::getInput ( )

inline

Returns the pointer for the _input structure of the model

Returns

The _input point

getInput() [2/2]

const Input* agent_model::Interface::getInput ( ) const

inline

Returns the const pointer for the _input structure of the model

Returns

The const _input point

getMemory() [1/2]

Memory* agent_model::Interface::getMemory ( )

inline

Returns the pointer for the _memory structure of the model

Returns

The _memory point

getMemory() [2/2]

const Memory* agent_model::Interface::getMemory ( ) const

inline

Returns the const pointer for the _memory structure of the model

Returns

The const _memory point

getParameters() [1/2]

Parameters* agent_model::Interface::getParameters ( )

inline

Returns the pointer for the _param structure of the model

Returns

The _param point

getParameters() [2/2]

const Parameters* agent_model::Interface::getParameters ( ) const

inline

Returns the const pointer for the _param structure of the model

Returns

The const _param point

getState() [1/2]

State* agent_model::Interface::getState ( )

inline

Returns the pointer for the _state structure of the model

Returns

The _state point

getState() [2/2]

const State* agent_model::Interface::getState ( ) const

inline

Returns the const pointer for the _state structure of the model

Returns

The const _state point

---

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

• src/Interface.h