simgear/hla/HLADataType.hxx

   1 // Copyright (C) 2009 - 2012  Mathias Froehlich - Mathias.Froehlich@web.de
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Library General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Library General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 //
  17
  18 #ifndef HLADataType_hxx
  19 #define HLADataType_hxx
  20
  21 #include <string>
  22 #include <simgear/structure/SGWeakPtr.hxx>
  23 #include <simgear/structure/SGWeakReferenced.hxx>
  24 #include "RTIData.hxx"
  25 #include "HLATypes.hxx"
  26
  27 namespace simgear {
  28
  29 class HLADataTypeVisitor;
  30
  31 class HLABasicDataType;
  32 class HLAArrayDataType;
  33 class HLAEnumeratedDataType;
  34 class HLAFixedRecordDataType;
  35 class HLAVariantRecordDataType;
  36
  37 class HLADataType : public SGWeakReferenced {
  38 public:
  39     virtual ~HLADataType();
  40
  41     const std::string& getName() const
  42     { return _name; }
  43
  44     const std::string& getSemantics() const
  45     { return _semantics; }
  46     void setSemantics(const std::string& semantics)
  47     { _semantics = semantics; }
  48
  49     unsigned getAlignment() const
  50     { return _alignment; }
  51
  52     virtual void accept(HLADataTypeVisitor& visitor) const;
  53
  54     virtual const HLABasicDataType* toBasicDataType() const;
  55     virtual const HLAArrayDataType* toArrayDataType() const;
  56     virtual const HLAEnumeratedDataType* toEnumeratedDataType() const;
  57     virtual const HLAFixedRecordDataType* toFixedRecordDataType() const;
  58     virtual const HLAVariantRecordDataType* toVariantRecordDataType() const;
  59
  60     /// Recompute the alignment value of this data type.
  61     /// Return true if the alignment changed, false otherwise.
  62     bool recomputeAlignment();
  63     /// Release references to other data types. Since we can have cycles this is
  64     /// required for propper feeing of memory.
  65     virtual void releaseDataTypeReferences();
  66
  67     bool getDataElementIndex(HLADataElementIndex& index, const std::string& path, std::string::size_type offset) const;
  68
  69 protected:
  70     HLADataType(const std::string& name, unsigned alignment = 1);
  71     void setAlignment(unsigned alignment);
  72
  73     virtual void _recomputeAlignmentImplementation();
  74
  75 private:
  76     class _DataElementIndexVisitor;
  77
  78     std::string _name;
  79     std::string _semantics;
  80     unsigned _alignment;
  81 };
  82
  83 } // namespace simgear
  84
  85 #endif