source: XIOS/dev/dev_ym/XIOS_COUPLING/src/node/coupler_out.hpp @ 2326

#ifndef __XIOS_CCouplerOut__
#define __XIOS_CCouplerOut__

/// XIOS headers ///
#include "xios_spl.hpp"
#include "field.hpp"
#include "declare_group.hpp"
#include "date.hpp"
#include "attribute_enum.hpp"
#include "attribute_enum_impl.hpp"
#include "context_client.hpp"
#include "mpi.hpp"

namespace xios
{

   /// ////////////////////// Déclarations ////////////////////// ///

   class CCouplerOutGroup;
   class CCouplerOutAttributes;
   class CCouplerOut;

   class CGarbageCollector;

   ///--------------------------------------------------------------

   // Declare/Define CCouplerOutAttribute
   BEGIN_DECLARE_ATTRIBUTE_MAP(CCouplerOut)
#  include "coupler_out_attribute.conf"
   END_DECLARE_ATTRIBUTE_MAP(CCouplerOut)

   ///--------------------------------------------------------------

   /*!
   \class CCouplerOut
   
   */
   class CCouplerOut
      : public CObjectTemplate<CCouplerOut>
      , public CCouplerOutAttributes
   {
         /// typedef ///
         typedef CObjectTemplate<CCouplerOut>   SuperClass;
         typedef CCouplerOutAttributes SuperClassAttribute;

      public :
         enum EEventId
         {
           EVENT_ID_COLLECTIVE=100,
           NO_EVENT,
           EVENT_ID_NO_COLLECTIVE=1000,
         };

         typedef CCouplerOutAttributes RelAttributes;
         typedef CCouplerOutGroup      RelGroup;

         /// Constructeurs ///
         CCouplerOut(void);
         explicit CCouplerOut(const StdString& id);
         CCouplerOut(const CCouplerOut& couplerOut);       // Not implemented yet.
         CCouplerOut(const CCouplerOut* const couplerOut); // Not implemented yet.

         /// Destructeur ///
         virtual ~CCouplerOut(void);

      public:
         /// Accesseurs ///
         CFieldGroup* getVirtualFieldGroup(void) const;
         std::vector<CField*> getAllFields(void) const;
         std::vector<CField* > getEnabledFields(void);

         StdString dumpClassAttributes(void);

      public :
         void setVirtualFieldGroup(CFieldGroup* newVFieldGroup);

         // Add component into coupler
         CField* addField(const string& id = "");
         CFieldGroup* addFieldGroup(const string& id = "");

      public:
         /// Accesseurs statiques ///
         static StdString GetName(void);
         static StdString GetDefName(void);
         static ENodeType GetType(void);
      public:
         /// Traitements ///
         virtual void parse(xml::CXMLNode& node);
//         virtual StdString toString(void) const;

      public:
        virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
        void solveFieldRefInheritance(bool apply);
        void createInterCommunicator(void) ;
        void checkGridOfEnabledFields(void) ;
        void assignContext(void) ;
      private:
        // the contextClient associated to the context Id attribute
        CContextClient* client_=nullptr ;
      public: 
        CContextClient* getContextClient(void) {return client_; }
      
      private:
        string couplingContextId_ ;
      public:
        const string& getCouplingContextId(void) ;  
      private:
         CFieldGroup* virtualFieldGroup;

//         std::shared_ptr<CDataOutput> data_out;
//         std::shared_ptr<CDataInput> data_in;
         std::vector<CField*> enabledFields;


      public:

   }; // class CCouplerOut

   ///--------------------------------------------------------------

   // Declare/Define CFileGroup and CFileDefinition
   DECLARE_GROUP(CCouplerOut);

   ///--------------------------------------------------------------

} // namespace xios

#endif // __XIOS_CCouplingIn__2