XMLIOSERVER 0.4
Serveur d'Entrées/Sorties parallèles
Référence de la classe xmlioserver::CObject

Classe abstraite de base dans l'arborescence d'objets de la bibliothèque. Plus de détails...

#include <object.hpp>

Graphe d'héritage de xmlioserver::CObject:

Liste de tous les membres

Fonctions membres publiques

virtual ~CObject (void)
 Destructeur de l'objet.
const std::string & getId (void) const
 Retourne l'identifiant de l'objet.
void resetId (void)
 Supprime l'identifiant de l'objet, rendant ce dernier anonyme.
void setId (const std::string &_new_id)
 Assigne un identifiant à l'objet courant.
bool hasId (void) const
 Indique si l'objet est identifié.
bool operator== (const CObject &_other_obj) const
 Indique si deux objets sont identiques.
bool operator!= (const CObject &_other_obj) const
 Indique si deux objets sont différents.
virtual std::string toString (void) const =0
 Retourne une représentation ascii de l'objet.
virtual void fromString (const std::string &_object_str)=0
 Modifie l'objet en fonction d'une chaîne de caractère.

Fonctions membres protégées

 CObject (void)
 Constructeur simple d'un objet anonyme (ie sans identifiant).
 CObject (const std::string &_id)
 Constructeur simple d'un objet identifié.
 CObject (const CObject &_object)
 Constructeur par copie .
 CObject (const CObject *const _object_ptr)
 Constructeur par copie.

Attributs privés

boost::optional< std::string > id
 (optionnel) Identifiant de l'objet.

Amis

std::ostream & operator<< (std::ostream &_os, const CObject &_object)
 Opérateur de flux de sortie ascii.

Description détaillée

Classe abstraite de base dans l'arborescence d'objets de la bibliothèque.

Définition à la ligne 39 du fichier object.hpp.


Documentation des constructeurs et destructeur

xmlioserver::CObject::~CObject ( void  ) [virtual]

Destructeur de l'objet.

Définition à la ligne 46 du fichier object.cpp.

xmlioserver::CObject::CObject ( void  ) [protected]

Constructeur simple d'un objet anonyme (ie sans identifiant).

Définition à la ligne 31 du fichier object.cpp.

xmlioserver::CObject::CObject ( const std::string &  _id) [explicit, protected]

Constructeur simple d'un objet identifié.

Paramètres:
_id: une chaîne de caractère permettant d'identifier l'objet.
Voir également:
id

Définition à la ligne 35 du fichier object.cpp.

xmlioserver::CObject::CObject ( const CObject _object) [protected]

Constructeur par copie .

Remarques:
L'objet d'origine (référencé) n'est jamais modifié.
Paramètres:
_object: référence de l'objet à copier.

Définition à la ligne 39 du fichier object.cpp.

xmlioserver::CObject::CObject ( const CObject *const  _object_ptr) [protected]

Constructeur par copie.

Remarques:
L'objet d'origine (pointé) n'est jamais modifié.
Paramètres:
_object_ptr: le pointeur sur l'objet à copier.

Documentation des fonctions membres

virtual void xmlioserver::CObject::fromString ( const std::string &  _object_str) [pure virtual]

Modifie l'objet en fonction d'une chaîne de caractère.

Paramètres:
_object_str: une représentation ascii de l'objet
Voir également:
toString

Implémenté dans xmlioserver::CException.

const std::string & xmlioserver::CObject::getId ( void  ) const

Retourne l'identifiant de l'objet.

Renvoie:
la chaîne de caractères permettant d'identifier l'objet.

Définition à la ligne 52 du fichier object.cpp.

Références hasId(), et XIOS_ERROR.

Référencé par xmlioserver::CException::getMessage().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool xmlioserver::CObject::hasId ( void  ) const

Indique si l'objet est identifié.

Renvoie:
true si l'objet est identifié, false sinon.

Définition à la ligne 63 du fichier object.cpp.

Référencé par getId(), et operator==().

Voici le graphe d'appel pour cette fonction :

bool xmlioserver::CObject::operator!= ( const CObject _other_obj) const

Indique si deux objets sont différents.

Paramètres:
_other_obj: l'objet à comparer avec l'élément courant.
Renvoie:
true si les objets sont différents, false sinon.
Remarques:
Deux objets sont identiques s'ils sont du même type et ont le même identifiant.

Définition à la ligne 92 du fichier object.cpp.

bool xmlioserver::CObject::operator== ( const CObject _other_obj) const

Indique si deux objets sont identiques.

Paramètres:
_other_obj: objet à comparer avec l'élément courant.
Renvoie:
true si les objets sont identiques, false sinon.
Remarques:
Deux objets sont identiques s'ils sont du même type et ont le même identifiant.

Définition à la ligne 85 du fichier object.cpp.

Références hasId(), et id.

Voici le graphe d'appel pour cette fonction :

void xmlioserver::CObject::resetId ( void  )

Supprime l'identifiant de l'objet, rendant ce dernier anonyme.

Définition à la ligne 71 du fichier object.cpp.

void xmlioserver::CObject::setId ( const std::string &  _new_id)

Assigne un identifiant à l'objet courant.

Paramètres:
_new_id: une chaîne de caractères identifiant l'objet.
Voir également:
id

Définition à la ligne 77 du fichier object.cpp.

Références id.

virtual std::string xmlioserver::CObject::toString ( void  ) const [pure virtual]

Retourne une représentation ascii de l'objet.

Renvoie:
Une représentation ascii de l'objet
Voir également:
fromString

Implémenté dans xmlioserver::CException.

Référencé par xmlioserver::operator<<().

Voici le graphe d'appel pour cette fonction :


Documentation des fonctions amies et associées

std::ostream& operator<< ( std::ostream &  _os,
const CObject _object 
) [friend]

Opérateur de flux de sortie ascii.

Paramètres:
_os: un objet de flux de sortie standard.
_object: l'objet à sérialiser sous forme ascii.
Renvoie:
Le paramètre _os éventuellement modifié après appel de la méthode.
Voir également:
toString

Définition à la ligne 100 du fichier object.cpp.


Documentation des données membres

boost::optional<std::string> xmlioserver::CObject::id [private]

(optionnel) Identifiant de l'objet.

Définition à la ligne 148 du fichier object.hpp.

Référencé par operator==(), et setId().


La documentation de cette classe a été générée à partir des fichiers suivants :
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Définition de type Amis Macros