source: XIOS/dev/dev_ym/XIOS_SERVICES/src/object_template_impl.hpp @ 1780

Last change on this file since 1780 was 1761, checked in by ymipsl, 5 years ago

implementing first guess for service functionnalities.

YM

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