simgear/hla/HLAObjectInstance.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 HLAObjectInstance_hxx
  19 #define HLAObjectInstance_hxx
  20
  21 #include <vector>
  22
  23 #include <simgear/structure/SGWeakPtr.hxx>
  24
  25 #include "HLADataElement.hxx"
  26 #include "HLATypes.hxx"
  27
  28 class SGTimeStamp;
  29
  30 namespace simgear {
  31
  32 class RTIObjectInstance;
  33 class HLAFederate;
  34 class HLAObjectClass;
  35
  36 class HLAObjectInstance : public SGWeakReferenced {
  37 public:
  38     HLAObjectInstance(HLAObjectClass* objectClass = 0);
  39     virtual ~HLAObjectInstance();
  40
  41     /// Return the name of this object instance
  42     const std::string& getName() const;
  43
  44     /// return the federate this instance belongs to
  45     const SGWeakPtr<HLAFederate>& getFederate() const;
  46
  47     /// Return the object class of this instance.
  48     /// Should always return a valid object class.
  49     const SGSharedPtr<HLAObjectClass>& getObjectClass() const;
  50
  51     /// Return the number of attributes
  52     unsigned getNumAttributes() const;
  53
  54     /// Return the attribute index for the attribute with the given name
  55     unsigned getAttributeIndex(const std::string& name) const;
  56     /// Return the attribute name for the attribute with the given index
  57     std::string getAttributeName(unsigned index) const;
  58
  59     /// Return true if the attribute with the given index is owned by
  60     /// this federate
  61     bool getAttributeOwned(unsigned index) const;
  62
  63     /// Return the data type of the attribute with the given index
  64     const HLADataType* getAttributeDataType(unsigned index) const;
  65
  66     /// Return the data element of the attribute with the given index
  67     HLADataElement* getAttributeDataElement(unsigned index);
  68     const HLADataElement* getAttributeDataElement(unsigned index) const;
  69
  70     /// Write the raw attribute data value into data, works only of the object
  71     /// is backed up with an rti object instance
  72     bool getAttributeData(unsigned index, RTIData& data) const;
  73
  74     /// Sets the data element of the attribute with the given index to dataElement
  75     void setAttributeDataElement(unsigned index, const SGSharedPtr<HLADataElement>& dataElement);
  76
  77     /// Retrieve the data element index for the given path.
  78     bool getDataElementIndex(HLADataElementIndex& index, const std::string& path) const;
  79     HLADataElementIndex getDataElementIndex(const std::string& path) const;
  80
  81     /// Return the data element of the attribute with the given index
  82     HLADataElement* getAttributeDataElement(const HLADataElementIndex& index);
  83     const HLADataElement* getAttributeDataElement(const HLADataElementIndex& index) const;
  84     /// Set the data element of the attribute with the given index
  85     void setAttributeDataElement(const HLADataElementIndex& index, const SGSharedPtr<HLADataElement>& dataElement);
  86
  87     /// Return the data element of the attribute with the given path.
  88     /// The method is only for convenience as parsing the path is expensive.
  89     /// Precompute the index and use the index instead if you use this method more often.
  90     HLADataElement* getAttributeDataElement(const std::string& path);
  91     const HLADataElement* getAttributeDataElement(const std::string& path) const;
  92     /// Set the data element of the attribute with the given path
  93     /// The method is only for convenience as parsing the path is expensive.
  94     /// Precompute the index and use the index instead if you use this method more often.
  95     void setAttributeDataElement(const std::string& path, const SGSharedPtr<HLADataElement>& dataElement);
  96
  97     /// Gets called on discovering this object instance.
  98     virtual void discoverInstance(const RTIData& tag);
  99     /// Gets called on remove this object instance.
 100     virtual void removeInstance(const RTIData& tag);
 101
 102     /// Call this to register the object instance at the rti and assign the object class to it.
 103     void registerInstance();
 104     virtual void registerInstance(HLAObjectClass* objectClass);
 105     /// Call this to delete the object instance from the rti.
 106     virtual void deleteInstance(const RTIData& tag);
 107
 108     /// Is called when the instance is either registered or discovered.
 109     /// It creates data elements for each element that is not yet set and that has a data type attached.
 110     /// the default calls back into the object class createAttributeDataElements method.
 111     virtual void createAttributeDataElements();
 112     /// Create and set the data element with index. Called somewhere in the above callchain.
 113     void createAndSetAttributeDataElement(unsigned index);
 114     /// Create an individual data element, the default calls back into the object class
 115     /// createAttributeDataElement method.
 116     virtual HLADataElement* createAttributeDataElement(unsigned index);
 117
 118     // Push the current values into the RTI
 119     virtual void updateAttributeValues(const RTIData& tag);
 120     virtual void updateAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
 121     // encode periodic and dirty attribute values for the next sendAttributeValues
 122     void encodeAttributeValues();
 123     // encode the attribute value at index i for the next sendAttributeValues
 124     void encodeAttributeValue(unsigned index);
 125
 126     // Really sends the prepared attribute update values into the RTI
 127     void sendAttributeValues(const RTIData& tag);
 128     void sendAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
 129
 130     class UpdateCallback : public SGReferenced {
 131     public:
 132         virtual ~UpdateCallback();
 133
 134         virtual void updateAttributeValues(HLAObjectInstance&, const RTIData&) = 0;
 135         virtual void updateAttributeValues(HLAObjectInstance&, const SGTimeStamp&, const RTIData&) = 0;
 136     };
 137
 138     void setUpdateCallback(const SGSharedPtr<UpdateCallback>& updateCallback)
 139     { _updateCallback = updateCallback; }
 140     const SGSharedPtr<UpdateCallback>& getUpdateCallback() const
 141     { return _updateCallback; }
 142
 143
 144     // Reflects the indices given in the index vector into the attributes HLADataElements.
 145     virtual void reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
 146     virtual void reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
 147     // Reflect a single attribute value at the given index into the attributes HLADataELement.
 148     virtual void reflectAttributeValue(unsigned index, const RTIData& tag);
 149     virtual void reflectAttributeValue(unsigned index, const SGTimeStamp& timeStamp, const RTIData& tag);
 150
 151     class ReflectCallback : public SGReferenced {
 152     public:
 153         virtual ~ReflectCallback();
 154
 155         virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const RTIData&) = 0;
 156         virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const SGTimeStamp&, const RTIData&) = 0;
 157     };
 158
 159     void setReflectCallback(const SGSharedPtr<ReflectCallback>& reflectCallback)
 160     { _reflectCallback = reflectCallback; }
 161     const SGSharedPtr<ReflectCallback>& getReflectCallback() const
 162     { return _reflectCallback; }
 163
 164 private:
 165     void _setRTIObjectInstance(RTIObjectInstance* rtiObjectInstance);
 166     void _clearRTIObjectInstance();
 167
 168     // The callback entry points from the RTI interface classes.
 169     void _removeInstance(const RTIData& tag);
 170     void _reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
 171     void _reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
 172
 173     struct Attribute {
 174         Attribute() : _enabledUpdate(false), _unconditionalUpdate(false) {}
 175         SGSharedPtr<HLADataElement> _dataElement;
 176         bool _enabledUpdate;
 177         bool _unconditionalUpdate;
 178         // HLAIndexList::iterator _unconditionalUpdateAttributeIndexListIterator;
 179         // HLAIndexList::iterator _conditionalUpdateAttributeIndexListIterator;
 180     };
 181     typedef std::vector<Attribute> AttributeVector;
 182
 183     // At some time we want these: Until then, use the _enabledUpdate and _unconditionalUpdate flags in the Attribute struct.
 184     // HLAIndexList _unconditionalUpdateAttributeIndexList;
 185     // HLAIndexList _conditionalUpdateAttributeIndexList;
 186
 187     /// The parent Federate
 188     SGWeakPtr<HLAFederate> _federate;
 189
 190     /// The ObjectClass
 191     SGSharedPtr<HLAObjectClass> _objectClass;
 192
 193     /// The name as known in the RTI
 194     std::string _name;
 195
 196     // /// The name as given by the local created instance
 197     // std::string _givenName;
 198
 199     /// The underlying rti dispatcher class
 200     SGSharedPtr<RTIObjectInstance> _rtiObjectInstance;
 201
 202     /// The attribute data
 203     AttributeVector _attributeVector;
 204
 205     // Callback classes
 206     SGSharedPtr<UpdateCallback> _updateCallback;
 207     SGSharedPtr<ReflectCallback> _reflectCallback;
 208
 209     friend class HLAFederate;
 210     friend class HLAObjectClass;
 211     friend class RTIObjectInstance;
 212 };
 213
 214 } // namespace simgear
 215
 216 #endif