Module.h

Go to the documentation of this file.

 
/*
 *  JEMRIS Copyright (C)
 *                        2006-2025  Tony Stoecker
 *                        2007-2018  Kaveh Vahedipour
 *                        2009-2019  Daniel Pflugfelder
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef MODULE_H_
#define MODULE_H_
 
 
#include "Prototype.h"
 
// Declaration to avoid inclusion of the header resulting in circular referentation
class SequenceTree;
class Parameters;
class ConcatSequence;
 
 
 
class Module : public Prototype {
 
 public:
 
    Module ();
 
    virtual ~Module () {};
 
    Module (const Module&);
 
    virtual Module* Clone() const = 0;
 
    virtual void GetValue (double * dAllVal,   double const time) {};
 
    /*
     * @brief Get values for available Transmit coils for simulation only.
     *
     * Get the values for each Transmit channel in this atomic sequence. And
     * return the in dAllVal.
     *
     * @param dAllVal represents the pointer to array where results are returned.
     * @param time    represents the time of invocation.
     * @param pos     represents the position in x, y, z.
     */
    //virtual void GetValue  (double * dAllVal, double const time, double * pos[3]) {};
 
    virtual bool Prepare  (const PrepareMode mode);
 
 
    void Initialize  (DOMNode* node );
 
    Module*         GetParent   ();
 
    virtual double GetDuration () = 0;
 
    virtual int     GetNumOfTPOIs () { return m_tpoi.GetSize(); };
 
    vector<Module*> GetChildren () const;
 
    vector<Module*> GetChildrenDynamic () const;
 
    Module*         GetChild    (unsigned int position) const;
 
    int GetNumberOfChildren () const;
 
    bool InsertChild (const string& name);
 
        virtual Module* GetPrototypeByAttributeValue (string name, string attrib);
 
    bool AddDOMattribute    (const string attribute, const string value);
 
    void AddAllDOMattributes (bool show_hidden = true);
 
     virtual TPOI* GetTPOIs () { return &m_tpoi; }
 
      void  DumpTree (const string& file="", Module* mod=NULL, int ichild = 0, int level = 0) ;
 
        int  GetDepth (int depth = 0) ;
 
     int GetHardwareMode () { return m_hardware_mode; }
 
      bool WriteStaticXML(const string& xml_file);
 
     bool StaticDOM(DOMDocument* doc, DOMNode* node, bool append = true);
 
 
     void                               SetSeqTree (SequenceTree* pST)  { m_seq_tree= pST;      };
     SequenceTree*      GetSeqTree (                             )      { return m_seq_tree;};
 
 
 protected:
 
    virtual string GetInfo () { return ""; };
 
    SequenceTree*  m_seq_tree;    
    Parameters*    m_parameters;  
    TPOI           m_tpoi;        
    string         m_info;           
    double         m_duration;       
    int            m_calls;          
    int            m_hardware_mode;  
 private:
 
 
};
 
#endif