Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

PGAgentInfo Class Reference

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

#include <PGAgentInfo.h>

Inheritance diagram for PGAgentInfo:

AgentInfo List of all members.

Public Member Functions

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

Detailed Description

API between Postgres and C for agents.

Author:
Richard DUFOUR
Version:
1.0
Date:
17-03-2006
Bug:
no one known
Warning:
beta version
That class defines the api of the language C and Postgresql for all the interactions with agents informations.


Member Function Documentation

PGAgentInfo::changeStateToAvailable string  aName  )  [virtual]
 

Permit to put the agent in mode available.

Parameters:
aName string which is the name of the agent.

Implements AgentInfo.

PGAgentInfo::changeStateToInUse string  aName  )  [virtual]
 

Permit to put the agent in mode in use.

Parameters:
aName string which is the name of the agent.

Implements AgentInfo.

PGAgentInfo::changeStateToRcvInfo string  aName  )  [virtual]
 

Permit to set that an agent received his informations.

Parameters:
aName string which is the name of the agent.

Implements AgentInfo.

PGAgentInfo::changeStateToUnrcvInfo string  aName  )  [virtual]
 

Permit to set that an agent not received his informations.

Parameters:
aName string which is the name of the agent.

Implements AgentInfo.

PGAgentInfo::checkStateToRcvInfo string  aName  )  [virtual]
 

Permit to know if informations was received.

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

Implements AgentInfo.

PGAgentInfo::deleteAgent string  aAgent  )  [virtual]
 

Permit to delete an agent.

Parameters:
aName string which is the name of the agent.

Implements AgentInfo.

PGAgentInfo::getAgents  )  [virtual]
 

Get all the agents.

Returns:
list<string> of agents names.

Implements AgentInfo.

PGAgentInfo::getAvailableAgents  )  [virtual]
 

Get all the available agents.

Returns:
list<string> of agents names.

Implements AgentInfo.

PGAgentInfo::getInformations string  aAgent  )  [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 (name + value).

Implements AgentInfo.

PGAgentInfo::getInUseAgents  )  [virtual]
 

Get all the agents in use.

Returns:
list<string> of agents names.

Implements AgentInfo.

PGAgentInfo::saveAgent string  aName,
map< string, string >  aInfo
[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.

Implements AgentInfo.

PGAgentInfo::updateAgent string  aName,
string  ip,
string  port,
map< string, string >  aInfo
[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.

Implements AgentInfo.


The documentation for this class was generated from the following file:
Generated on Fri May 19 22:56:55 2006 for k10-controller by  doxygen 1.4.4