# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLAINIMAT::IBlackBox Class Reference

An interface between an agent and a C++ component. More...

#include <black_box.h>

Inheritance diagram for NLAINIMAT::IBlackBox

Inheritance graph
[legend]
Collaboration diagram for NLAINIMAT::IBlackBox:

Collaboration graph
[legend]
List of all members.

Public Methods

 IBlackBox ()
Description functions
Give the interface (Inputs, Outputs, ParamaeterIn and ParameterOut) of the IBlackBox.

virtual tCommandList getInputList () const = 0
 Return the list of Inputs for command signal. More...

virtual tCommandList getOutputList () const = 0
 Return the list of Outputs for command signal. More...

virtual tParameterList getParamInList () const = 0
 Return the list of parameters used by the IBlackBox. More...

virtual tParameterList getParamOutList () const = 0
 Return the list of parameters returned by the IBlackBox. More...

Running functions
Functions used during the run time of the IBlackBox.

virtual void setInput (tString inputName, bool) = 0
 Fix the value of an input signal.

virtual bool getOutput (tString outputName) = 0
 Return the value of an output signal.

virtual void setParamIn (tString parameterName, IObjectIA val) = 0
 Set the value of an input parameter.

virtual const IObjectIAgetParamOut (tString parameterName) = 0
 Get the value of an output parameter.

virtual tParameterList getNeededParamIn () const = 0
 Return a list of the parameters which need to be updated.


Detailed Description

An interface between an agent and a C++ component.

An IBlackBox is an interface for any component which can be use in the built of an agent. It's like an electronique component which can be plug in an agent. There can be input and output parameter and input and output command signal.

Author(s):
Robert Gabriel , Nevrax France
Date:
2000

Definition at line 42 of file black_box.h.


Constructor & Destructor Documentation

NLAINIMAT::IBlackBox::IBlackBox ( )
 


Member Function Documentation

tCommandList NLAINIMAT::IBlackBox::getInputList ( ) const [pure virtual]
 

Return the list of Inputs for command signal.

It's a list of the differents pins which can be triggered when receiving an incoming event.

tParameterList NLAINIMAT::IBlackBox::getNeededParamIn ( ) const [pure virtual]
 

Return a list of the parameters which need to be updated.

bool NLAINIMAT::IBlackBox::getOutput ( tString outputName ) [pure virtual]
 

Return the value of an output signal.

tCommandList NLAINIMAT::IBlackBox::getOutputList ( ) const [pure virtual]
 

Return the list of Outputs for command signal.

It's a list of the differents pins which allows to send an event, to triggered anoter IBlackBox.

tParameterList NLAINIMAT::IBlackBox::getParamInList ( ) const [pure virtual]
 

Return the list of parameters used by the IBlackBox.

It's the name and type of each parameters.

const IObjectIA * NLAINIMAT::IBlackBox::getParamOut ( tString parameterName ) [pure virtual]
 

Get the value of an output parameter.

tParameterList NLAINIMAT::IBlackBox::getParamOutList ( ) const [pure virtual]
 

Return the list of parameters returned by the IBlackBox.

It's the name and type of each parameters.

void NLAINIMAT::IBlackBox::setInput ( tString inputName,
bool ) [pure virtual]
 

Fix the value of an input signal.

void NLAINIMAT::IBlackBox::setParamIn ( tString parameterName,
IObjectIA val ) [pure virtual]
 

Set the value of an input parameter.


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