source: XIOS/dev/dev_olga/src/object_template_impl.hpp @ 1612

Last change on this file since 1612 was 1612, checked in by oabramkina, 21 months ago

Dev: adding exception handling.

To activate it, compilation flag -DXIOS_EXCEPTION should be added.

  • 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: 18.5 KB
Line 
1#ifndef __XIOS_CObjectTemplate_impl__
2#define __XIOS_CObjectTemplate_impl__
3
4#include "xios_spl.hpp"
5#include "context_client.hpp"
6#include "object_factory.hpp"
7#include "context.hpp"
8#include "buffer_in.hpp"
9#include "attribute.hpp"
10#include "event_client.hpp"
11#include "object_template.hpp"
12#include "context_client.hpp"
13#include "indent.hpp"
14#include "type_util.hpp"
15#include "message.hpp"
16#include "type.hpp"
17#include "type_util.hpp"
18#include "group_template.hpp"
19
20namespace xios
21{
22   /// ////////////////////// Définitions ////////////////////// ///
23   template <class T>
24      xios_map<StdString,
25      xios_map<StdString,
26      std::shared_ptr<T> > > CObjectTemplate<T>::AllMapObj;
27
28   template <class T>
29      xios_map<StdString,
30      std::vector<std::shared_ptr<T> > > CObjectTemplate<T>::AllVectObj;
31
32   template <class T>
33      xios_map<StdString,long int> CObjectTemplate<T>::GenId;
34
35   template <class T>
36      CObjectTemplate<T>::CObjectTemplate(void)
37         : CAttributeMap()
38         , CObject()
39   { /* Ne rien faire de plus */ }
40
41   template <class T>
42      CObjectTemplate<T>::CObjectTemplate(const StdString & id)
43         : CAttributeMap()
44         , CObject(id, CObjectFactory::IsGenUId<T>(id))
45   { /* Ne rien faire de plus */ }
46
47   template <class T>
48      CObjectTemplate<T>::CObjectTemplate
49         (const CObjectTemplate<T> & object, bool withAttrList, bool withId)
50         : CAttributeMap()
51         , CObject()
52   {
53      if (object.hasId() && withId)
54         this->setId(object.getId(), object.hasAutoGeneratedId());
55      ERROR("CObjectTemplate<T> construtor 3", << "Not completly implemented yet !");
56   }
57
58   template <class T>
59      CObjectTemplate<T>::~CObjectTemplate(void)
60   { /* Ne rien faire de plus */ }
61
62   ///--------------------------------------------------------------
63
64   template <class T>
65      std::vector<std::shared_ptr<T> > &
66         CObjectTemplate<T>::GetAllVectobject(const StdString & contextId)
67   {
68      return (CObjectTemplate<T>::AllVectObj[contextId]);
69   }
70
71   //---------------------------------------------------------------
72
73   template <class T>
74      StdString CObjectTemplate<T>::toString(void) const
75   {
76      StdOStringStream oss;
77      oss << "<" << T::GetName();
78      if (this->hasId())
79         oss << " id=\"" << this->getId() << "\"";
80      oss << " " << SuperClassMap::toString() << "/>";
81      return (oss.str());
82   }
83
84   template <class T>
85      void CObjectTemplate<T>::fromString(const StdString & str)
86   {
87      ERROR("CObjectTemplate<T>::fromString(str)",
88            << "[ str = " << str << "] Not implemented yet !");
89   }
90
91   //---------------------------------------------------------------
92
93/*
94   template <class T>
95      void CObjectTemplate<T>::toBinary(StdOStream & os) const
96   {
97      SuperClassMap::toBinary(os);
98   }
99
100   template <class T>
101      void CObjectTemplate<T>::fromBinary(StdIStream & is)
102   {
103      SuperClassMap::fromBinary(is);
104   }
105*/
106
107   //---------------------------------------------------------------
108
109   template <class T>
110      void CObjectTemplate<T>::parse(xml::CXMLNode & node)
111   TRY
112   {
113      xml::THashAttributes attributes = node.getAttributes();
114      CAttributeMap::setAttributes(attributes);
115   }
116   CATCH
117
118   //---------------------------------------------------------------
119
120   template <class T>
121      ENodeType CObjectTemplate<T>::getType(void) const
122   {
123      return (T::GetType());
124   }
125
126   template <class T>
127   string CObjectTemplate<T>::getName(void) const
128   {
129      return (T::GetName());
130   }
131
132   //---------------------------------------------------------------
133
134   template <class T>
135      bool CObjectTemplate<T>::hasChild(void) const
136   {
137      return (false);
138   }
139
140   /*!
141     Compare two object of same type
142   */
143   template <class T>
144   bool CObjectTemplate<T>::isEqual(const string& id, const vector<StdString>& excludedAttrs)
145   {
146      T* obj = CObjectTemplate<T>::get(id);
147      return this->isEqual(obj, excludedAttrs);
148   }
149
150   template <class T>
151   bool CObjectTemplate<T>::isEqual(T* obj, const vector<StdString>& excludedAttrs)
152   {
153
154      CAttributeMap& attrMapThis = *this;
155      CAttributeMap& attrMapObj  = *obj;
156      return (attrMapThis.isEqual(attrMapObj, excludedAttrs));
157   }
158
159   //---------------------------------------------------------------
160
161   template <class T>
162      void CObjectTemplate<T>::solveDescInheritance(bool apply, const CAttributeMap * const parent)
163   {
164      if (parent != NULL)
165         SuperClassMap::setAttributes(parent, apply);
166   }
167
168   //---------------------------------------------------------------
169
170   template <class T>
171      void CObjectTemplate<T>::ClearAllAttributes(void)
172   {
173      vector<T*> avect = CObjectTemplate<T>::getAll();
174      typename vector<T*>::iterator
175            it = avect.begin(), end = avect.end();
176
177      for (;it != end; it++)
178      {
179         CAttributeMap & amap = **it;
180         amap.clearAllAttributes();
181      }
182   }
183
184   template<typename T>
185   std::map<int, size_t> CObjectTemplate<T>::getMinimumBufferSizeForAttributes(CContextClient* client)
186   {
187     std::map<int, size_t> minimumSizes;
188
189     if (client->isServerLeader())
190     {
191       size_t minimumSize = 0;
192       CAttributeMap& attrMap = *this;
193       CAttributeMap::const_iterator it = attrMap.begin(), itE = attrMap.end();
194       for (; it != itE; ++it)
195       {
196         if (!it->second->isEmpty())
197         {
198           size_t size = it->second->getName().size() + sizeof(size_t) + it->second->size();
199           if (size > minimumSize)
200             minimumSize = size;
201         }
202       }
203
204       if (minimumSize)
205       {
206         // Account for extra header info
207         minimumSize += CEventClient::headerSize + getIdServer().size() + sizeof(size_t);
208
209         const std::list<int>& ranks = client->getRanksServerLeader();
210         for (std::list<int>::const_iterator itRank = ranks.begin(), itRankEnd = ranks.end(); itRank != itRankEnd; ++itRank)
211           minimumSizes.insert(std::make_pair(*itRank, minimumSize));
212       }
213     }
214     return minimumSizes;
215   }
216
217
218   template<typename T>
219   void CObjectTemplate<T>::sendAllAttributesToServer()
220   {
221     CAttributeMap& attrMap = *this;
222     CAttributeMap::const_iterator it = attrMap.begin(), itE = attrMap.end();
223     for (; it != itE; ++it)
224     {
225       if (it->second->doSend() && !(it->second)->isEmpty()) sendAttributToServer(*(it->second));
226     }
227   }
228
229   template<typename T>
230   void CObjectTemplate<T>::sendAllAttributesToServer(CContextClient* client)
231   {
232     CAttributeMap& attrMap = *this;
233     CAttributeMap::const_iterator it = attrMap.begin(), itE = attrMap.end();
234     for (; it != itE; ++it)
235     {
236       if (it->second->doSend() && !(it->second)->isEmpty()) sendAttributToServer(*(it->second), client);
237     }
238   }
239
240   template <class T>
241   void CObjectTemplate<T>::sendAttributToServer(const string& id)
242   {
243      CAttributeMap & attrMap = *this;
244      CAttribute* attr=attrMap[id];
245      sendAttributToServer(*attr);
246   }
247
248   template <class T>
249   void CObjectTemplate<T>::sendAttributToServer(const string& id, CContextClient* client)
250   {
251      CAttributeMap & attrMap = *this;
252      CAttribute* attr=attrMap[id];
253      sendAttributToServer(*attr, client);
254   }
255
256  template <class T>
257  void CObjectTemplate<T>::sendAttributToServer(CAttribute& attr)
258  {
259     // Use correct context client to send message
260    CContext* context=CContext::getCurrent();
261    if (context->hasClient)
262    {
263      // int nbSrvPools = (context->hasServer) ? context->clientPrimServer.size() : 1;
264      int nbSrvPools = (context->hasServer) ? (context->hasClient ? context->clientPrimServer.size() : 0) : 1;
265      for (int i = 0; i < nbSrvPools; ++i)
266      {
267        CContextClient* contextClientTmp = (context->hasServer) ? context->clientPrimServer[i] : context->client;
268        CEventClient event(getType(),EVENT_ID_SEND_ATTRIBUTE);
269        if (contextClientTmp->isServerLeader())
270        {
271          CMessage msg;
272          msg<<this->getIdServer();
273          msg << attr.getName();
274          msg << attr;
275          const std::list<int>& ranks = contextClientTmp->getRanksServerLeader();
276          for (std::list<int>::const_iterator itRank = ranks.begin(), itRankEnd = ranks.end(); itRank != itRankEnd; ++itRank)
277            event.push(*itRank,1,msg);
278          contextClientTmp->sendEvent(event);
279        }
280        else contextClientTmp->sendEvent(event);
281      }
282    }
283  }
284
285  template <class T>
286  void CObjectTemplate<T>::sendAttributToServer(CAttribute& attr, CContextClient* client)
287  {
288    CEventClient event(getType(),EVENT_ID_SEND_ATTRIBUTE);
289    if (client->isServerLeader())
290    {
291      CMessage msg;
292      msg<<this->getIdServer();
293      msg << attr.getName();
294      msg << attr;
295      const std::list<int>& ranks = client->getRanksServerLeader();
296      for (std::list<int>::const_iterator itRank = ranks.begin(), itRankEnd = ranks.end(); itRank != itRankEnd; ++itRank)
297        event.push(*itRank,1,msg);
298      client->sendEvent(event);
299    }
300    else client->sendEvent(event);
301  }
302
303  /*!
304    This generic funtion only provides instance for sending, for receving, each
305    child class must define itself.
306    \param [in] id Id of added item
307    \param [in] itemType type of added item
308  */
309  template<class T>
310  void CObjectTemplate<T>::sendAddItem(const StdString& id, int itemType)
311  {
312    CContext* context = CContext::getCurrent();
313    typedef typename T::EEventId ItemType;
314    if (context->hasClient)
315    {
316      // Use correct context client to send message
317      // int nbSrvPools = (context->hasServer) ? context->clientPrimServer.size() : 1;
318      int nbSrvPools = (context->hasServer) ? (context->hasClient ? context->clientPrimServer.size() : 0) : 1;
319      for (int i = 0; i < nbSrvPools; ++i)
320      {
321         CContextClient* contextClientTmp = (context->hasServer) ? context->clientPrimServer[i] : context->client;
322         CEventClient event(this->getType(),ItemType(itemType));
323         if (contextClientTmp->isServerLeader())
324         {
325           CMessage msg;
326           msg << this->getId();
327           msg << id;
328           const std::list<int>& ranks = contextClientTmp->getRanksServerLeader();
329           for (std::list<int>::const_iterator itRank = ranks.begin(), itRankEnd = ranks.end(); itRank != itRankEnd; ++itRank)
330             event.push(*itRank,1,msg);
331           contextClientTmp->sendEvent(event);
332         }
333         else contextClientTmp->sendEvent(event);
334      }
335    }
336  }
337
338  template<class T>
339  void CObjectTemplate<T>::sendAddItem(const StdString& id, int itemType, CContextClient* client)
340  {
341    typedef typename T::EEventId ItemType;
342     CEventClient event(this->getType(),ItemType(itemType));
343     if (client->isServerLeader())
344     {
345       CMessage msg;
346       msg << this->getId();
347       msg << id;
348       const std::list<int>& ranks = client->getRanksServerLeader();
349       for (std::list<int>::const_iterator itRank = ranks.begin(), itRankEnd = ranks.end(); itRank != itRankEnd; ++itRank)
350         event.push(*itRank,1,msg);
351       client->sendEvent(event);
352     }
353     else client->sendEvent(event);
354  }
355
356  template <class T>
357  void CObjectTemplate<T>::recvAttributFromClient(CEventServer& event)
358  {
359
360    CBufferIn* buffer=event.subEvents.begin()->buffer;
361    string id,attrId;
362    *buffer>>id;
363    CAttributeMap & attrMap = *get(id);
364    *buffer>>attrId;
365    CAttribute* attr=attrMap[attrId];
366    info(50) << "attribut recu " << attrId << "  ";
367    if (attr->isEmpty()) info(50) << "--> empty" << endl;
368    else info(50) /*<attr->getValue()*/ << endl;
369    *buffer>>*attr;
370     info(50) << "attribut recu " << attrId << "  ";
371    if (attr->isEmpty()) info(50) << "--> empty" << endl;
372    else info(50) /*attr->getValue()*/ << endl;
373  }
374
375   template <class T>
376   bool CObjectTemplate<T>::dispatchEvent(CEventServer& event)
377   {
378      switch(event.type)
379      {
380         case EVENT_ID_SEND_ATTRIBUTE :
381           recvAttributFromClient(event);
382           return true;
383           break;
384
385         default :
386         return false;
387//           ERROR("void CObjectTemplate<T>::recvEvent(CEventServer& event)", << "Unknown Event");
388      }
389   }
390
391   template <typename T>
392   bool CObjectTemplate<T>::has(const string & id)
393   {
394     return CObjectFactory::HasObject<T>(id);
395   }
396
397   template <typename T>
398   bool CObjectTemplate<T>::has(const string& contextId, const string & id)
399   {
400     return CObjectFactory::HasObject<T>(contextId,id);
401   }
402
403   template <typename T>
404   T* CObjectTemplate<T>::get(const string & id)
405   {
406     return CObjectFactory::GetObject<T>(id).get();
407   }
408
409   template <typename T>
410   T* CObjectTemplate<T>::get(const T* ptr)
411   {
412     return CObjectFactory::GetObject<T>(ptr).get();
413   }
414
415   template <typename T>
416   std::shared_ptr<T> CObjectTemplate<T>::getShared(const T* ptr)
417   {
418     return CObjectFactory::GetObject<T>(ptr);
419   }
420
421   template <typename T>
422   std::shared_ptr<T> CObjectTemplate<T>::getShared(void)
423   {
424     return CObjectFactory::GetObject<T>((T*)this);
425   }
426
427   template <typename T>
428   const vector<T*> CObjectTemplate<T>::getAll()
429   {
430     const vector< std::shared_ptr<T> >& shared_vect= CObjectFactory::GetObjectVector<T>();
431     vector<T*> vect;
432
433     typename vector<std::shared_ptr<T> >::const_iterator it;
434     for(it=shared_vect.begin();it!=shared_vect.end();++it) vect.push_back(it->get());
435     return vect;
436   }
437
438   template <typename T>
439   const vector<T*> CObjectTemplate<T>::getAll(const string & id)
440   {
441     const vector< std::shared_ptr<T> >& shared_vect= CObjectFactory::GetObjectVector<T>(id);
442     vector<T*> vect;
443
444     typename vector<std::shared_ptr<T> >::const_iterator it;
445     for(it=shared_vect.begin();it!=shared_vect.end();++it) vect.push_back(it->get());
446     return vect;
447   }
448
449   template <typename T>
450   T* CObjectTemplate<T>::get(const string& contextId, const string & id)
451   {
452     return CObjectFactory::GetObject<T>(contextId,id).get();
453   }
454
455   template <typename T>
456   T* CObjectTemplate<T>::create(const string & id)
457   {
458     return CObjectFactory::CreateObject<T>(id).get();
459   }   ///--------------------------------------------------------------
460
461  template <typename T>
462  T* CObjectTemplate<T>::get(void)
463  {
464    return CObjectFactory::GetObject<T>((T*)this).get();
465  }
466
467   template <typename T>
468   void CObjectTemplate<T>::generateCInterface(ostream& oss)
469   {
470     string className=getName();
471     int found=className.rfind("_group");
472     if (found!=string::npos) className.replace(found,1,0,'x');
473
474     oss << "/* ************************************************************************** *" << iendl;
475     oss << " *               Interface auto generated - do not modify                     *" << iendl;
476     oss << " * ************************************************************************** */" << iendl;
477     oss << iendl;
478     oss << "#include <boost/multi_array.hpp>" << iendl;
479     oss << "#include <boostXXX/shared_ptr.hpp>" << iendl;
480     oss << "#include \"xios.hpp\"" << iendl;
481     oss << "#include \"attribute_template.hpp\"" << iendl;
482     oss << "#include \"object_template.hpp\"" << iendl;
483     oss << "#include \"group_template.hpp\"" << iendl;
484     oss << "#include \"icutil.hpp\"" << iendl;
485     oss << "#include \"icdate.hpp\"" << iendl;
486     oss << "#include \"timer.hpp\"" << iendl;
487     oss << "#include \"node_type.hpp\"" << iendl;
488     oss << iendl;
489     oss << "extern \"C\"" << iendl;
490     oss << "{" << iendl++;
491     oss << "typedef xios::" << getStrType<T>() << "* " << className << "_Ptr;";
492     SuperClassMap::generateCInterface(oss,className);
493     oss << "}" << iendl--;
494   }
495
496   template <typename T>
497   void CObjectTemplate<T>::generateFortran2003Interface(ostream& oss)
498   {
499     string className=getName();
500     int found=className.rfind("_group");
501     if (found!=string::npos) className.replace(found,1,0,'x');
502
503     oss << "! * ************************************************************************** *" << iendl;
504     oss << "! *               Interface auto generated - do not modify                     *" << iendl;
505     oss << "! * ************************************************************************** *" << iendl;
506     oss << "#include \"../fortran/xios_fortran_prefix.hpp\"" << iendl;
507     oss << iendl;
508     oss << "MODULE " << className << "_interface_attr" << iendl++;
509     oss << "USE, INTRINSIC :: ISO_C_BINDING" << std::endl;
510     oss << iendl;
511     oss << "INTERFACE" << iendl++;
512     oss << "! Do not call directly / interface FORTRAN 2003 <-> C99";
513     SuperClassMap::generateFortran2003Interface(oss,className);
514     oss << iendl--;
515     oss << "END INTERFACE" << iendl--;
516     oss << iendl;
517     oss << "END MODULE " << className << "_interface_attr" << iendl;
518   }
519
520   template <typename T>
521   void CObjectTemplate<T>::generateFortranInterface(ostream& oss)
522   {
523     string className=getName();
524     int found=className.rfind("_group");
525     if (found!=string::npos) className.erase(found,1);
526     string superClassName=getName();
527     found=superClassName.find("_group");
528     if (found!=string::npos) superClassName.erase(found,6);
529
530     oss << "! * ************************************************************************** *" << iendl;
531     oss << "! *               Interface auto generated - do not modify                     *" << iendl;
532     oss << "! * ************************************************************************** *" << iendl;
533     oss << "#include \"xios_fortran_prefix.hpp\"" << iendl;
534     oss << iendl;
535     oss << "MODULE i" << className << "_attr" << iendl++;
536     oss << "USE, INTRINSIC :: ISO_C_BINDING" << iendl;
537     oss << "USE i" << superClassName << iendl;
538     oss << "USE " << className << "_interface_attr" << iendl--;
539//   oss << "TYPE txios(" << className << ")" << iendl;
540//   oss << "  INTEGER(kind = C_INTPTR_T) :: daddr" << iendl;
541//   oss << "END TYPE txios(" << className << ")" << iendl;
542     oss << iendl;
543     oss << "CONTAINS" << iendl;
544     oss << iendl++;
545     SuperClassMap::generateFortranInterface_id(oss,className);
546     oss << iendl;
547     SuperClassMap::generateFortranInterface_hdl(oss,className);
548     oss << iendl;
549     SuperClassMap::generateFortranInterface_hdl_(oss,className);
550     oss << iendl;
551     SuperClassMap::generateFortranInterfaceGet_id(oss,className);
552     oss << iendl;
553     SuperClassMap::generateFortranInterfaceGet_hdl(oss,className);
554     oss << iendl;
555     SuperClassMap::generateFortranInterfaceGet_hdl_(oss,className);
556     oss << iendl;
557     SuperClassMap::generateFortranInterfaceIsDefined_id(oss,className);
558     oss << iendl;
559     SuperClassMap::generateFortranInterfaceIsDefined_hdl(oss,className);
560     oss << iendl;
561     SuperClassMap::generateFortranInterfaceIsDefined_hdl_(oss,className);
562     oss << iendl--;
563     oss << "END MODULE i" << className << "_attr" << iendl;
564   }
565} // namespace xios
566
567#endif // __XIOS_CObjectTemplate_impl__
Note: See TracBrowser for help on using the repository browser.