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 void registerInstance();
81 void registerInstance(HLAObjectClass* objectClass);
82 void deleteInstance(const RTIData& tag);
84 // Push the current values into the RTI
85 virtual void updateAttributeValues(const RTIData& tag);
86 virtual void updateAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
87 // encode periodic and dirty attribute values for the next sendAttributeValues
88 void encodeAttributeValues();
89 // encode the attribute value at index i for the next sendAttributeValues
90 void encodeAttributeValue(unsigned index);
92 // Really sends the prepared attribute update values into the RTI
93 void sendAttributeValues(const RTIData& tag);
94 void sendAttributeValues(const SGTimeStamp& timeStamp, const RTIData& tag);
96 class UpdateCallback : public SGReferenced {
98 virtual ~UpdateCallback();
100 virtual void updateAttributeValues(HLAObjectInstance&, const RTIData&) = 0;
101 virtual void updateAttributeValues(HLAObjectInstance&, const SGTimeStamp&, const RTIData&) = 0;
104 void setUpdateCallback(const SGSharedPtr<UpdateCallback>& updateCallback)
105 { _updateCallback = updateCallback; }
106 const SGSharedPtr<UpdateCallback>& getUpdateCallback() const
107 { return _updateCallback; }
110 // Reflects the indices given in the index vector into the attributes HLADataElements.
111 virtual void reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
112 virtual void reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
113 // Reflect a single attribute value at the given index into the attributes HLADataELement.
114 virtual void reflectAttributeValue(unsigned index, const RTIData& tag);
115 virtual void reflectAttributeValue(unsigned index, const SGTimeStamp& timeStamp, const RTIData& tag);
117 class ReflectCallback : public SGReferenced {
119 virtual ~ReflectCallback();
121 virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const RTIData&) = 0;
122 virtual void reflectAttributeValues(HLAObjectInstance&, const HLAIndexList&, const SGTimeStamp&, const RTIData&) = 0;
125 void setReflectCallback(const SGSharedPtr<ReflectCallback>& reflectCallback)
126 { _reflectCallback = reflectCallback; }
127 const SGSharedPtr<ReflectCallback>& getReflectCallback() const
128 { return _reflectCallback; }
131 void _setRTIObjectInstance(RTIObjectInstance* rtiObjectInstance);
132 void _clearRTIObjectInstance();
134 // The callback entry points from the RTI interface classes.
135 void _removeInstance(const RTIData& tag);
136 void _reflectAttributeValues(const HLAIndexList& indexList, const RTIData& tag);
137 void _reflectAttributeValues(const HLAIndexList& indexList, const SGTimeStamp& timeStamp, const RTIData& tag);
139 class DataElementFactoryVisitor;
142 Attribute() : _enabledUpdate(false), _unconditionalUpdate(false) {}
143 SGSharedPtr<HLADataElement> _dataElement;
145 bool _unconditionalUpdate;
146 // HLAIndexList::iterator _unconditionalUpdateAttributeIndexListIterator;
147 // HLAIndexList::iterator _conditionalUpdateAttributeIndexListIterator;
149 typedef std::vector<Attribute> AttributeVector;
151 // At some time we want these: Until then, use the _enabledUpdate and _unconditionalUpdate flags in the Attribute struct.
152 // HLAIndexList _unconditionalUpdateAttributeIndexList;
153 // HLAIndexList _conditionalUpdateAttributeIndexList;
155 /// The parent Federate
156 SGWeakPtr<HLAFederate> _federate;
159 SGSharedPtr<HLAObjectClass> _objectClass;
161 /// The name as known in the RTI
164 // /// The name as given by the local created instance
165 // std::string _givenName;
167 /// The underlying rti dispatcher class
168 SGSharedPtr<RTIObjectInstance> _rtiObjectInstance;
170 /// The attribute data
171 AttributeVector _attributeVector;
174 SGSharedPtr<UpdateCallback> _updateCallback;
175 SGSharedPtr<ReflectCallback> _reflectCallback;
177 friend class HLAFederate;
178 friend class HLAObjectClass;
179 friend class RTIObjectInstance;
182 } // namespace simgear