1 // Copyright (C) 2009 - 2012 Mathias Froehlich - Mathias.Froehlich@web.de
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.
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.
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.
18 #ifndef HLAObjectInstance_hxx
19 #define HLAObjectInstance_hxx
23 #include <simgear/structure/SGWeakPtr.hxx>
25 #include "HLADataElement.hxx"
26 #include "HLATypes.hxx"
32 class RTIObjectInstance;
36 class HLAObjectInstance : public SGWeakReferenced {
38 HLAObjectInstance(HLAObjectClass* objectClass = 0);
39 virtual ~HLAObjectInstance();
41 /// Return the name of this object instance
42 const std::string& getName() const;
44 /// return the federate this instance belongs to
45 const SGWeakPtr<HLAFederate>& getFederate() const;
47 /// Return the object class of this instance.
48 /// Should always return a valid object class.
49 const SGSharedPtr<HLAObjectClass>& getObjectClass() const;
51 /// Return the number of attributes
52 unsigned getNumAttributes() const;
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;
59 /// Return true if the attribute with the given index is owned by
61 bool getAttributeOwned(unsigned index) const;
63 /// Return the data type of the attribute with the given index
64 const HLADataType* getAttributeDataType(unsigned index) const;
66 /// Return the data element of the attribute with the given index
67 HLADataElement* getAttributeDataElement(unsigned index);
68 const HLADataElement* getAttributeDataElement(unsigned index) const;
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;
74 /// Sets the data element of the attribute with the given index to dataElement
75 void setAttributeDataElement(unsigned index, const SGSharedPtr<HLADataElement>& dataElement);
76 /// Sets the data element of the attribute with the given index to the content of pathElementMap
77 void setAttribute(unsigned index, const HLAPathElementMap& pathElementMap);
78 void setAttributes(const HLAAttributePathElementMap& attributePathElementMap);
80 /// Gets called on discovering this object instance.
81 virtual void discoverInstance(const RTIData& tag);
82 /// Gets called on remove this object instance.
83 virtual void removeInstance(const RTIData& tag);
85 /// Call this to register the object instance at the rti and assign the object class to it.
86 void registerInstance();
87 virtual void registerInstance(HLAObjectClass* objectClass);
88 /// Call this to delete the object instance from the rti.
89 virtual void deleteInstance(const RTIData& tag);
91 /// Is called when the instance is either registered or discovered.
92 /// It creates data elements for each element that is not yet set and that has a data type attached.
93 /// the default calls back into the object class createAttributeDataElements method.
94 virtual void createAttributeDataElements();
95 /// Create and set the data element with index. Called somewhere in the above callchain.
96 void createAndSetAttributeDataElement(unsigned index);
97 /// Create an individual data element, the default calls back into the object class
98 /// createAttributeDataElement method.
99 virtual HLADataElement* createAttributeDataElement(unsigned index);
101 // Push the current values into the RTI
102 virtual void updateAttributeValues(const RTIData& tag);
103 virtual void updateAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
104 // encode periodic and dirty attribute values for the next sendAttributeValues
105 void encodeAttributeValues();
106 // encode the attribute value at index i for the next sendAttributeValues
107 void encodeAttributeValue(unsigned index);
109 // Really sends the prepared attribute update values into the RTI
110 void sendAttributeValues(const RTIData& tag);
111 void sendAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
113 class UpdateCallback : public SGReferenced {
115 virtual ~UpdateCallback();
117 virtual void updateAttributeValues(HLAObjectInstance&, const RTIData&) = 0;
118 virtual void updateAttributeValues(HLAObjectInstance&, const SGTimeStamp&, const RTIData&) = 0;
121 void setUpdateCallback(const SGSharedPtr<UpdateCallback>& updateCallback)
122 { _updateCallback = updateCallback; }
123 const SGSharedPtr<UpdateCallback>& getUpdateCallback() const
124 { return _updateCallback; }
127 // Reflects the indices given in the index vector into the attributes HLADataElements.
128 virtual void reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
129 virtual void reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
130 // Reflect a single attribute value at the given index into the attributes HLADataELement.
131 virtual void reflectAttributeValue(unsigned index, const RTIData& tag);
132 virtual void reflectAttributeValue(unsigned index, const SGTimeStamp& timeStamp, const RTIData& tag);
134 class ReflectCallback : public SGReferenced {
136 virtual ~ReflectCallback();
138 virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const RTIData&) = 0;
139 virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const SGTimeStamp&, const RTIData&) = 0;
142 void setReflectCallback(const SGSharedPtr<ReflectCallback>& reflectCallback)
143 { _reflectCallback = reflectCallback; }
144 const SGSharedPtr<ReflectCallback>& getReflectCallback() const
145 { return _reflectCallback; }
148 void _setRTIObjectInstance(RTIObjectInstance* rtiObjectInstance);
149 void _clearRTIObjectInstance();
151 // The callback entry points from the RTI interface classes.
152 void _removeInstance(const RTIData& tag);
153 void _reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
154 void _reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
156 class DataElementFactoryVisitor;
159 Attribute() : _enabledUpdate(false), _unconditionalUpdate(false) {}
160 SGSharedPtr<HLADataElement> _dataElement;
162 bool _unconditionalUpdate;
163 // HLAIndexList::iterator _unconditionalUpdateAttributeIndexListIterator;
164 // HLAIndexList::iterator _conditionalUpdateAttributeIndexListIterator;
166 typedef std::vector<Attribute> AttributeVector;
168 // At some time we want these: Until then, use the _enabledUpdate and _unconditionalUpdate flags in the Attribute struct.
169 // HLAIndexList _unconditionalUpdateAttributeIndexList;
170 // HLAIndexList _conditionalUpdateAttributeIndexList;
172 /// The parent Federate
173 SGWeakPtr<HLAFederate> _federate;
176 SGSharedPtr<HLAObjectClass> _objectClass;
178 /// The name as known in the RTI
181 // /// The name as given by the local created instance
182 // std::string _givenName;
184 /// The underlying rti dispatcher class
185 SGSharedPtr<RTIObjectInstance> _rtiObjectInstance;
187 /// The attribute data
188 AttributeVector _attributeVector;
191 SGSharedPtr<UpdateCallback> _updateCallback;
192 SGSharedPtr<ReflectCallback> _reflectCallback;
194 friend class HLAFederate;
195 friend class HLAObjectClass;
196 friend class RTIObjectInstance;
199 } // namespace simgear