source: XIOS/dev/dev_ym/XIOS_COUPLING/src/object_template.hpp @ 2243

Last change on this file since 2243 was 2243, checked in by jderouillat, 8 months ago

Move context cleaning in xios_finalize (for clients) and when servers have finished their work

  • Property copyright set to
    Software name : XIOS (Xml I/O Server)
    http://forge.ipsl.jussieu.fr/ioserver
    Creation date : January 2009
    Licence : CeCCIL version2
    see license file in root directory : Licence_CeCILL_V2-en.txt
    or http://www.cecill.info/licences/Licence_CeCILL_V2-en.html
    Holder : CEA/LSCE (Laboratoire des Sciences du CLimat et de l'Environnement)
    CNRS/IPSL (Institut Pierre Simon Laplace)
    Project Manager : Yann Meurdesoif
    yann.meurdesoif@cea.fr
File size: 5.1 KB
Line 
1#ifndef __XIOS_CObjectTemplate__
2#define __XIOS_CObjectTemplate__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "attribute_map.hpp"
7#include "node_enum.hpp"
8#include "buffer_in.hpp"
9#include "event_server.hpp"
10#include "attribute.hpp"
11#include "context_client.hpp"
12
13namespace xios
14{
15   /// ////////////////////// Déclarations ////////////////////// ///
16   template <class T>
17      class CObjectTemplate
18         : public CObject
19         , public virtual CAttributeMap
20   {
21
22         /// Friend ///
23         friend class CObjectFactory;
24
25         /// Typedef ///
26         typedef CAttributeMap SuperClassMap;
27         typedef CObject SuperClass;
28         typedef T DerivedType;
29
30         enum EEventId
31         {
32           EVENT_ID_SEND_ATTRIBUTE=100
33         } ;
34
35      public :
36
37         /// Autres ///
38         virtual StdString toString(void) const;
39         virtual void fromString(const StdString & str);
40
41//         virtual void toBinary  (StdOStream & os) const;
42//         virtual void fromBinary(StdIStream & is);
43         virtual string getName(void) const ;
44         virtual void parse(xml::CXMLNode & node);
45
46         /// Accesseurs ///
47         ENodeType getType(void) const;
48
49         /// Test ///
50         virtual bool hasChild(void) const;
51
52         /// Traitements ///
53         virtual void solveDescInheritance(bool apply, const CAttributeMap * const parent = 0);
54 
55         /// Traitement statique ///
56         static void ClearAllAttributes(void);
57         std::map<int, size_t> getMinimumBufferSizeForAttributes(CContextClient* client);
58         void sendAttributToServer(const string& id, CContextClient* client, const string& objectId="");
59         void sendAttributToServer(CAttribute& attr, CContextClient* client, const string& objectId="") ;
60         void sendAllAttributesToServer(CContextClient* client, const string& objectId="");
61         void sendAddItem(const string& id, int itemType, CContextClient* client, const string& objectId="");
62         static void recvAttributFromClient(CEventServer& event) ;
63         static bool dispatchEvent(CEventServer& event) ;
64
65         bool isEqual(const string& id, const vector<StdString>& excludedAttrs);
66         bool isEqual(T* obj, const vector<StdString>& excludedAttrs);
67
68         /// Accesseur statique ///
69         static std::vector<std::shared_ptr<DerivedType> > &
70            GetAllVectobject(const StdString & contextId);
71
72         /// Destructeur ///
73         virtual ~CObjectTemplate(void);
74         
75         static void cleanStaticDataStructure(void);     
76
77         static bool has(const string& id) ;
78         static bool has(const string& contextId, const string& id) ;
79         static T* get(const string& id) ;
80         static T* get(const T* ptr) ;
81         static T* get(const string& contextId, const string& id) ;
82         T* get(void) ;
83         std::shared_ptr<T> getShared(void) ;
84         static std::shared_ptr<T> getShared(const T* ptr) ;
85
86         static T* create(const string& id=string("")) ;
87         static T* createAlias(const string& id, const string& alias) ;
88         void createAlias(const string& alias) ;
89
90         static const vector<T*> getAll() ;
91         static const vector<T*> getAll(const string& contextId) ;
92
93         void generateCInterface(ostream& oss) ;
94         void generateFortran2003Interface(ostream& oss) ;
95         void generateFortranInterface(ostream& oss) ;
96     
97      // manage inherited id which is herited by reference
98        void setInheritedId(T* obj) ;
99        bool hasInheritedId(void) { return hasInheritedId_ ;}
100        string getInheritedId(void) { return  inheritedId_ ;}
101
102      private: 
103         std::string inheritedId_ ;
104         bool hasInheritedId_ = false;
105
106      // manage the template id
107      public:
108         void setTemplateId(T* obj) ; //<! set the id of the object that served as template
109         bool hasTemplateId(void) {return hasTemplateId_;} //<! return  hasTemplateId_
110         string getTemplateId(void)
111         {
112           if (hasTemplateId_) return templateId_  ;
113           else if (hasId() && !hasAutoGeneratedId()) return getId() ;
114           else if (hasInheritedId()) return getInheritedId() ;
115           else return getId() ;
116         }
117      private:
118         std::string templateId_ ;    //<! the id of the object that served as template
119         bool hasTemplateId_ = false; //<! true if templateId is set
120     
121      protected :
122
123         /// Constructeurs ///
124         CObjectTemplate(void);
125         explicit CObjectTemplate(const StdString & id);
126         CObjectTemplate(const CObjectTemplate<T> & object,
127                         bool withAttrList = true, bool withId = true);
128         CObjectTemplate(const CObjectTemplate<T> * const object); // Not implemented.
129
130      private :
131
132         /// Propriétés statiques ///
133         static xios_map<StdString,
134                xios_map<StdString,
135                std::shared_ptr<DerivedType> > > AllMapObj;
136         static xios_map<StdString,
137                std::vector<std::shared_ptr<DerivedType> > > AllVectObj;
138
139         static xios_map< StdString, long int > GenId ;
140
141   }; // class CObjectTemplate
142} // namespace xios
143
144//#include "object_template_impl.hpp"
145
146#endif // __XIOS_CObjectTemplate__
Note: See TracBrowser for help on using the repository browser.