AgentInfo Class Reference

API between Database and C for agents. More...

#include <AgentInfo.h>

Inheritance diagram for AgentInfo:

List of all members.

Public Member Functions
	AgentInfo ()
	AgentInfo constructor.
virtual	~AgentInfo ()
	AgentInfo destructor.
virtual list< string >	getAvailableAgents ()=0
	Get all the available agents.
virtual list< string >	getInUseAgents ()=0
	Get all the agents in use.
virtual list< string >	getAgents ()=0
	Get all the agents.
virtual void	saveAgent (string aName, map< string, string > aInfo)=0
	Permit to save a new agent.
virtual void	updateAgent (string aName, string aIp, string aPort, map< string, string > aInfo)=0
	Permit to update an agent in the database.
virtual void	changeStateToAvailable (string aName)=0
	Permit to put the agent in mode available.
virtual void	changeStateToInUse (string aName)=0
	Permit to put the agent in mode in use.
virtual void	changeStateToUnrcvInfo (string aName)=0
	Permit to set that an agent not received his informations.
virtual void	changeStateToRcvInfo (string aName)=0
	Permit to to set that an agent received his informations.
virtual bool	checkStateToRcvInfo (string aName)=0
	Permit to know if informations was received.
virtual void	deleteAgent (string aAgent)=0
	Permit to delete an agent.
virtual map< string, string >	getInformations (string aAgent)=0
	Permit to get the informations of an agent.

---

Detailed Description

API between Database and C for agents.

Author:

Richard DUFOUR

Version:

1.0

Date:

17-03-2006

Bug:

no one known

Warning:

beta version

That interface defines the api of the language C and database for all the interactions with agents informations. This is a general interface, which must be implements in order to use a specific database

---

Member Function Documentation

AgentInfo::changeStateToAvailable (  string  aName  )  [pure virtual]

Permit to put the agent in mode available. Parameters: aName  string which is the name of the agent. Implemented in PGAgentInfo.

AgentInfo::changeStateToInUse (  string  aName  )  [pure virtual]

Permit to put the agent in mode in use. Parameters: aName  string which is the name of the agent. Implemented in PGAgentInfo.

AgentInfo::changeStateToRcvInfo (  string  aName  )  [pure virtual]

Permit to to set that an agent received his informations. Parameters: aName  string which is the name of the agent. Implemented in PGAgentInfo.

AgentInfo::changeStateToUnrcvInfo (  string  aName  )  [pure virtual]

Permit to set that an agent not received his informations. Parameters: aName  string which is the name of the agent. Implemented in PGAgentInfo.

AgentInfo::checkStateToRcvInfo (  string  aName  )  [pure virtual]

Permit to know if informations was received. Parameters: aName  string which is the name of the agent. Returns: aBoolean true which permit to know if informations was received. Implemented in PGAgentInfo.

AgentInfo::deleteAgent (  string  aAgent  )  [pure virtual]

Permit to delete an agent. Parameters: aName  string which is the name of the agent. Implemented in PGAgentInfo.

AgentInfo::getAgents (   )  [pure virtual]

Get all the agents. Returns: list<string> of agents names. Implemented in PGAgentInfo.

AgentInfo::getAvailableAgents (   )  [pure virtual]

Get all the available agents. Returns: list<string> of agents names. Implemented in PGAgentInfo.

AgentInfo::getInformations (  string  aAgent  )  [pure virtual]

Permit to get the informations of an agent. Parameters: aName  string which is the name of the agent. Returns: map<string,string> of agents informations. Implemented in PGAgentInfo.

AgentInfo::getInUseAgents (   )  [pure virtual]

Get all the agents in use. Returns: list<string> of agents names. Implemented in PGAgentInfo.

AgentInfo::saveAgent (  string  aName, map< string, string >  aInfo )  [pure virtual]

Permit to save a new agent. Parameters: aName  string which is the name of the agent. aInfo  map<string,string> which represents the informations of the agent. Implemented in PGAgentInfo.

AgentInfo::updateAgent (  string  aName, string  ip, string  port, map< string, string >  aInfo )  [pure virtual]

Permit to update an agent in the database. Parameters: aIp  string which is the ip address of the agent. aPort  string which is the port of the agent. aInfo  map<string,string> which is the infos of the agent. Implemented in PGAgentInfo.

---

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

• dao/src/AgentInfo.h

---