From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../doxygen/nel/classNLAIAGENT_1_1IAgentInput.html | 785 +++++++++++++++++++++ 1 file changed, 785 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1IAgentInput.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1IAgentInput.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1IAgentInput.html b/docs/doxygen/nel/classNLAIAGENT_1_1IAgentInput.html new file mode 100644 index 00000000..d2d5b859 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1IAgentInput.html @@ -0,0 +1,785 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# 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  
+

NLAIAGENT::IAgentInput Class Reference

An interface giving a direct value from an agent component or telling when the value changed. +More... +

+#include <agent_input.h> +

+

Inheritance diagram for NLAIAGENT::IAgentInput: +

+ +NLAIAGENT::IConnectIA +NLAIAGENT::IRefrence +NLAIAGENT::IObjectIA +NLAIAGENT::IBasicObjectIA +NLAIC::IBasicInterface +NLAIC::IBasicType +NLAIC::IPointerGestion +NLMISC::IStreamable +NLMISC::IClassable + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 IAgentInput ()
 Constructor. More...

 IAgentInput (const IAgentInput &)
 IAgentInput (IObjectIA *)
 Constructor with an value. More...

virtual ~IAgentInput ()
 Destructor. More...

virtual bool isEqual (const IBasicObjectIA &a) const
 The bool operator==(const IBasicObjectIA &a) const member method call this function when class 'classType' have the same type of this class, programme have to assume the equality between the memebers of this class and the memeber of the class 'classType'. More...

virtual const CProcessResult & getState () const
virtual void setState (TProcessStatement s, IObjectIA *result)
void addInputConnection (IConnectIA *obj)
 Add an obj to the list of IconnectIA interested by the value change. More...

void releaseInputConnexion (IConnectIA *obj)
 Remove an obj to the list of IconnectIA interested by the value change. More...

virtual const IObjectIA * getValue () const
 Return the value managed by this IAgentInput. Must be Reimplemented. More...

virtual void setValue (IObjectIA *)
virtual const CProcessResult runMsg (COnChangeMsg &msg)
IObjectIA member method.
virtual const CProcessResult & run ()
 Some where Run method define the process of the agen. More...

IConnectIA member method.
virtual void onKill (IConnectIA *c)
 When agent die and when he is in the Connectioned lis, he call this method to inform this state to the objects. More...

IBasicInterface member method.
virtual void save (NLMISC::IStream &)
 Save the class in a stream. More...

virtual void load (NLMISC::IStream &)
 Load the class from a stream. More...


Protected Attributes

bool _ActiveInput
IObjectIA * _LocalValue
CListGroupManager _ConnexionList
+

Detailed Description

+An interface giving a direct value from an agent component or telling when the value changed. +

+

+Author:
+Gabriel ROBERT , Nevrax France
+Date:
+2001
+

+ +

+Definition at line 42 of file agent_input.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::IAgentInput::IAgentInput (   ) 
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 31 of file agent_input.cpp.

+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IAgentInput::IAgentInput ( const IAgentInput &   ) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 39 of file agent_input.cpp.

+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IAgentInput::IAgentInput ( IObjectIA *   ) 
+
+ + + + + +
+   + + +

+Constructor with an value. +

+ +

+Definition at line 35 of file agent_input.cpp.

+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::IAgentInput::~IAgentInput (   )  [virtual]
+
+ + + + + +
+   + + +

+Destructor. +

+ +

+Definition at line 43 of file agent_input.cpp. +

+References _LocalValue.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::addInputConnection ( IConnectIA *   obj ) 
+
+ + + + + +
+   + + +

+Add an obj to the list of IconnectIA interested by the value change. +

+ +

+Definition at line 48 of file agent_input.cpp. +

+References _ActiveInput, _ConnexionList, and NLAIAGENT::IConnectIA::connect.

+

+ + + + +
+ + + + + + + + + +
virtual const CProcessResult& NLAIAGENT::IAgentInput::getState (   )  const [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Implements NLAIAGENT::IConnectIA. +

+Definition at line 63 of file agent_input.h.

+

+ + + + +
+ + + + + + + + + +
virtual const IObjectIA* NLAIAGENT::IAgentInput::getValue (   )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Return the value managed by this IAgentInput. Must be Reimplemented. +

+ +

+Definition at line 76 of file agent_input.h. +

+References _LocalValue, and NLAIAGENT::IObjectIA::IObjectIA.

+

+ + + + +
+ + + + + + + + + + +
bool NLAIAGENT::IAgentInput::isEqual ( const IBasicObjectIA &   a )  const [virtual]
+
+ + + + + +
+   + + +

+The bool operator==(const IBasicObjectIA &a) const member method call this function when class 'classType' have the same type of this class, programme have to assume the equality between the memebers of this class and the memeber of the class 'classType'. +

+ +

+Implements NLAIAGENT::IBasicObjectIA. +

+Definition at line 112 of file agent_input.cpp. +

+References _LocalValue.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::load ( NLMISC::IStream &   )  [virtual]
+
+ + + + + +
+   + + +

+Load the class from a stream. +

+ +

+Implements NLAIAGENT::IConnectIA. +

+Definition at line 104 of file agent_input.cpp. +

+References _ActiveInput, _ConnexionList, and NLMISC::IStream::serial.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::onKill ( IConnectIA *   c )  [virtual]
+
+ + + + + +
+   + + +

+When agent die and when he is in the Connectioned lis, he call this method to inform this state to the objects. +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Definition at line 65 of file agent_input.cpp. +

+References releaseInputConnexion.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::releaseInputConnexion ( IConnectIA *   obj ) 
+
+ + + + + +
+   + + +

+Remove an obj to the list of IconnectIA interested by the value change. +

+ +

+Definition at line 55 of file agent_input.cpp. +

+References _ActiveInput, _ConnexionList, and NLAIAGENT::IConnectIA::removeConnection. +

+Referenced by onKill.

+

+ + + + +
+ + + + + + + + + +
const IObjectIA::CProcessResult & NLAIAGENT::IAgentInput::run (   )  [virtual]
+
+ + + + + +
+   + + +

+Some where Run method define the process of the agen. +

+ +

+Implements NLAIAGENT::IObjectIA. +

+Definition at line 81 of file agent_input.cpp. +

+References _LocalValue, NLAIAGENT::IObjectIA::IObjectIA, setValue, and value.

+

+ + + + +
+ + + + + + + + + + +
const IObjectIA::CProcessResult NLAIAGENT::IAgentInput::runMsg ( COnChangeMsg &   msg )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 70 of file agent_input.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::save ( NLMISC::IStream &   )  [virtual]
+
+ + + + + +
+   + + +

+Save the class in a stream. +

+ +

+Implements NLAIAGENT::IConnectIA. +

+Definition at line 97 of file agent_input.cpp. +

+References _ActiveInput, _ConnexionList, and NLMISC::IStream::serial.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLAIAGENT::IAgentInput::setState ( TProcessStatement   s,
IObjectIA *   result
)  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Implements NLAIAGENT::IConnectIA. +

+Definition at line 67 of file agent_input.h. +

+References NLAIAGENT::IObjectIA::IObjectIA, s, and NLAIAGENT::TProcessStatement.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IAgentInput::setValue ( IObjectIA *   )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 75 of file agent_input.cpp. +

+References _LocalValue. +

+Referenced by run.

+

Member Data Documentation

+

+ + + + +
+ + +
bool NLAIAGENT::IAgentInput::_ActiveInput [protected] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 45 of file agent_input.h. +

+Referenced by addInputConnection, load, releaseInputConnexion, and save.

+

+ + + + +
+ + +
CListGroupManager NLAIAGENT::IAgentInput::_ConnexionList [protected] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file agent_input.h. +

+Referenced by addInputConnection, load, releaseInputConnexion, and save.

+

+ + + + +
+ + +
IObjectIA* NLAIAGENT::IAgentInput::_LocalValue [protected] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 46 of file agent_input.h. +

+Referenced by getValue, isEqual, run, setValue, and ~IAgentInput.

+

The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1