simgear/hla/HLADataType.hxx

   1 // Copyright (C) 2009 - 2010  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
  26 namespace simgear {
  27
  28 class HLADataTypeVisitor;
  29
  30 class HLADataTypeReference;
  31 class HLABasicDataType;
  32 class HLAArrayDataType;
  33 class HLAEnumeratedDataType;
  34 class HLAFixedRecordDataType;
  35 class HLAVariantRecordDataType;
  36
  37 enum HLAUpdateType {
  38     HLAStaticUpdate,
  39     HLAPeriodicUpdate,
  40     HLAConditionalUpdate,
  41     HLAUndefinedUpdate
  42 };
  43
  44 class HLADataType : public SGWeakReferenced {
  45 public:
  46     virtual ~HLADataType();
  47
  48     const std::string& getName() const
  49     { return _name; }
  50
  51     const std::string& getSemantics() const
  52     { return _semantics; }
  53     void setSemantics(const std::string& semantics)
  54     { _semantics = semantics; }
  55
  56     unsigned getAlignment() const
  57     { return _alignment; }
  58
  59     virtual void accept(HLADataTypeVisitor& visitor) const;
  60
  61     virtual const HLADataTypeReference* toDataTypeReference() const;
  62     virtual const HLABasicDataType* toBasicDataType() const;
  63     virtual const HLAArrayDataType* toArrayDataType() const;
  64     virtual const HLAEnumeratedDataType* toEnumeratedDataType() const;
  65     virtual const HLAFixedRecordDataType* toFixedRecordDataType() const;
  66     /// deprecated
  67     const HLAVariantRecordDataType* toVariantDataType() const { return toVariantRecordDataType(); }
  68     virtual const HLAVariantRecordDataType* toVariantRecordDataType() const;
  69
  70 protected:
  71     HLADataType(const std::string& name, unsigned alignment = 1);
  72     void setAlignment(unsigned alignment);
  73
  74 private:
  75     std::string _name;
  76     std::string _semantics;
  77     unsigned _alignment;
  78 };
  79
  80 // Weak reference to a data type. Used to implement self referencing data types
  81 class HLADataTypeReference : public HLADataType {
  82 public:
  83     HLADataTypeReference(const SGSharedPtr<HLADataType>& dataType) :
  84         HLADataType(dataType->getName(), dataType->getAlignment()),
  85         _dataType(dataType)
  86     { }
  87     virtual ~HLADataTypeReference();
  88
  89     SGSharedPtr<const HLADataType> getDataType() const
  90     { return _dataType.lock(); }
  91
  92     virtual void accept(HLADataTypeVisitor& visitor) const;
  93     virtual const HLADataTypeReference* toDataTypeReference() const;
  94
  95 private:
  96     SGWeakPtr<const HLADataType> _dataType;
  97 };
  98
  99 } // namespace simgear
 100
 101 #endif