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.
19 # include <simgear_config.h>
22 #include <simgear/compiler.h>
24 #include "HLAObjectClass.hxx"
26 #include "simgear/debug/logstream.hxx"
27 #include "RTIFederate.hxx"
28 #include "RTIObjectClass.hxx"
29 #include "RTIObjectInstance.hxx"
30 #include "HLADataType.hxx"
31 #include "HLADataTypeVisitor.hxx"
32 #include "HLAFederate.hxx"
33 #include "HLAObjectInstance.hxx"
37 HLAObjectClass::InstanceCallback::~InstanceCallback()
42 HLAObjectClass::InstanceCallback::discoverInstance(const HLAObjectClass&, HLAObjectInstance& objectInstance, const RTIData& tag)
47 HLAObjectClass::InstanceCallback::removeInstance(const HLAObjectClass&, HLAObjectInstance& objectInstance, const RTIData& tag)
52 HLAObjectClass::InstanceCallback::registerInstance(const HLAObjectClass&, HLAObjectInstance& objectInstance)
57 HLAObjectClass::InstanceCallback::deleteInstance(const HLAObjectClass&, HLAObjectInstance& objectInstance)
61 HLAObjectClass::RegistrationCallback::~RegistrationCallback()
65 HLAObjectClass::HLAObjectClass(const std::string& name, HLAFederate* federate) :
70 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass::HLAObjectClass(): "
71 "No parent federate given for object class \"" << getName() << "\"!");
74 federate->_insertObjectClass(this);
77 HLAObjectClass::~HLAObjectClass()
79 // HLAObjectClass objects only get deleted when the parent federate
80 // dies. So we do not need to deregister there.
82 _clearRTIObjectClass();
86 HLAObjectClass::getName() const
91 const SGWeakPtr<HLAFederate>&
92 HLAObjectClass::getFederate() const
98 HLAObjectClass::getNumAttributes() const
100 return _attributeVector.size();
104 HLAObjectClass::addAttribute(const std::string& name)
106 unsigned index = _attributeVector.size();
107 _nameIndexMap[name] = index;
108 _attributeVector.push_back(Attribute(name));
109 _resolveAttributeIndex(name, index);
114 HLAObjectClass::getAttributeIndex(const std::string& name) const
116 NameIndexMap::const_iterator i = _nameIndexMap.find(name);
117 if (i == _nameIndexMap.end())
123 HLAObjectClass::getAttributeName(unsigned index) const
125 if (_attributeVector.size() <= index)
126 return std::string();
127 return _attributeVector[index]._name;
131 HLAObjectClass::getAttributeDataType(unsigned index) const
133 if (_attributeVector.size() <= index)
135 return _attributeVector[index]._dataType.get();
139 HLAObjectClass::setAttributeDataType(unsigned index, const HLADataType* dataType)
141 if (_attributeVector.size() <= index)
143 _attributeVector[index]._dataType = dataType;
147 HLAObjectClass::getAttributeUpdateType(unsigned index) const
149 if (_attributeVector.size() <= index)
150 return HLAUndefinedUpdate;
151 return _attributeVector[index]._updateType;
155 HLAObjectClass::setAttributeUpdateType(unsigned index, HLAUpdateType updateType)
157 if (_attributeVector.size() <= index)
159 _attributeVector[index]._updateType = updateType;
163 HLAObjectClass::getAttributeSubscriptionType(unsigned index) const
165 if (_attributeVector.size() <= index)
166 return HLAUnsubscribed;
167 return _attributeVector[index]._subscriptionType;
171 HLAObjectClass::setAttributeSubscriptionType(unsigned index, HLASubscriptionType subscriptionType)
173 if (_attributeVector.size() <= index)
175 _attributeVector[index]._subscriptionType = subscriptionType;
179 HLAObjectClass::getAttributePublicationType(unsigned index) const
181 if (_attributeVector.size() <= index)
182 return HLAUnpublished;
183 return _attributeVector[index]._publicationType;
187 HLAObjectClass::setAttributePublicationType(unsigned index, HLAPublicationType publicationType)
189 if (_attributeVector.size() <= index)
191 _attributeVector[index]._publicationType = publicationType;
195 HLAObjectClass::getDataElementIndex(HLADataElementIndex& dataElementIndex, const std::string& path) const
198 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: failed to parse empty element path!");
201 std::string::size_type len = std::min(path.find_first_of("[."), path.size());
203 while (index < getNumAttributes()) {
204 if (path.compare(0, len, getAttributeName(index)) == 0)
208 if (getNumAttributes() <= index) {
209 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: faild to parse data element index \"" << path << "\":\n"
210 << "Attribute \"" << path.substr(0, len) << "\" not found in object class \""
211 << getName() << "\"!");
214 if (!getAttributeDataType(index)) {
215 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: faild to parse data element index \"" << path << "\":\n"
216 << "Undefined attribute data type in variant record data type \""
217 << getAttributeName(index) << "\"!");
220 dataElementIndex.push_back(index);
221 return getAttributeDataType(index)->getDataElementIndex(dataElementIndex, path, len);
225 HLAObjectClass::getDataElementIndex(const std::string& path) const
227 HLADataElementIndex dataElementIndex;
228 getDataElementIndex(dataElementIndex, path);
229 return dataElementIndex;
233 HLAObjectClass::subscribe()
235 if (!_rtiObjectClass.valid()) {
236 SG_LOG(SG_NETWORK, SG_WARN, "HLAObjectClass::subscribe(): "
237 "No RTIObject class for object class \"" << getName() << "\"!");
241 HLAIndexList indexList;
242 for (unsigned i = 1; i < getNumAttributes(); ++i) {
243 if (_attributeVector[i]._subscriptionType != HLASubscribedActive)
245 indexList.push_back(i);
247 if (!indexList.empty()) {
248 if (!_rtiObjectClass->subscribe(indexList, true))
253 for (unsigned i = 1; i < getNumAttributes(); ++i) {
254 if (_attributeVector[i]._subscriptionType != HLASubscribedPassive)
256 indexList.push_back(i);
258 if (!indexList.empty()) {
259 if (!_rtiObjectClass->subscribe(indexList, false))
266 HLAObjectClass::unsubscribe()
268 if (!_rtiObjectClass.valid()) {
269 SG_LOG(SG_NETWORK, SG_WARN, "HLAObjectClass::unsubscribe(): "
270 "No RTIObject class for object class \"" << getName() << "\"!");
273 return _rtiObjectClass->unsubscribe();
277 HLAObjectClass::publish()
279 if (!_rtiObjectClass.valid()) {
280 SG_LOG(SG_NETWORK, SG_WARN, "HLAObjectClass::publish(): "
281 "No RTIObject class for object class \"" << getName() << "\"!");
285 HLAIndexList indexList;
286 for (unsigned i = 1; i < getNumAttributes(); ++i) {
287 if (_attributeVector[i]._publicationType == HLAUnpublished)
289 indexList.push_back(i);
291 if (indexList.empty())
293 if (!_rtiObjectClass->publish(indexList))
299 HLAObjectClass::unpublish()
301 if (!_rtiObjectClass.valid()) {
302 SG_LOG(SG_NETWORK, SG_WARN, "HLAObjectClass::unpublish(): "
303 "No RTIObject class for object class \"" << getName() << "\"!");
306 return _rtiObjectClass->unpublish();
310 HLAObjectClass::discoverInstance(HLAObjectInstance& objectInstance, const RTIData& tag)
312 if (_instanceCallback.valid())
313 _instanceCallback->discoverInstance(*this, objectInstance, tag);
317 HLAObjectClass::removeInstance(HLAObjectInstance& objectInstance, const RTIData& tag)
319 if (_instanceCallback.valid())
320 _instanceCallback->removeInstance(*this, objectInstance, tag);
324 HLAObjectClass::registerInstance(HLAObjectInstance& objectInstance)
326 if (_instanceCallback.valid())
327 _instanceCallback->registerInstance(*this, objectInstance);
331 HLAObjectClass::deleteInstance(HLAObjectInstance& objectInstance)
333 if (_instanceCallback.valid())
334 _instanceCallback->deleteInstance(*this, objectInstance);
338 HLAObjectClass::startRegistration() const
343 HLAObjectClass::stopRegistration() const
348 HLAObjectClass::createObjectInstance(const std::string& name)
350 SGSharedPtr<HLAFederate> federate = _federate.lock();
351 if (!federate.valid())
353 return federate->createObjectInstance(this, name);
357 HLAObjectClass::createAttributeDataElements(HLAObjectInstance& objectInstance)
359 unsigned numAttributes = getNumAttributes();
360 for (unsigned i = 0; i < numAttributes; ++i)
361 objectInstance.createAndSetAttributeDataElement(i);
365 HLAObjectClass::createAttributeDataElement(HLAObjectInstance& objectInstance, unsigned index)
367 // FIXME here we want to have a vector of factories and if this fails do the following
368 const HLADataType* dataType = getAttributeDataType(index);
371 HLADataElementFactoryVisitor dataElementFactoryVisitor;
372 dataType->accept(dataElementFactoryVisitor);
373 return dataElementFactoryVisitor.getDataElement();
377 HLAObjectClass::_setRTIObjectClass(RTIObjectClass* objectClass)
379 if (_rtiObjectClass) {
380 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: Setting RTIObjectClass twice for object class \"" << getName() << "\"!");
383 _rtiObjectClass = objectClass;
384 if (_rtiObjectClass->_objectClass != this) {
385 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: backward reference does not match!");
388 for (unsigned i = 0; i < _attributeVector.size(); ++i)
389 _resolveAttributeIndex(_attributeVector[i]._name, i);
393 HLAObjectClass::_resolveAttributeIndex(const std::string& name, unsigned index)
395 if (!_rtiObjectClass)
397 if (!_rtiObjectClass->resolveAttributeIndex(name, index))
398 SG_LOG(SG_NETWORK, SG_ALERT, "HLAObjectClass: Could not resolve attribute \""
399 << name << "\" for object class \"" << getName() << "\"!");
403 HLAObjectClass::_clearRTIObjectClass()
405 if (!_rtiObjectClass.valid())
407 _rtiObjectClass->_objectClass = 0;
412 HLAObjectClass::_discoverInstance(RTIObjectInstance* rtiObjectInstance, const RTIData& tag)
414 SGSharedPtr<HLAFederate> federate = _federate.lock();
415 if (!federate.valid()) {
416 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not find parent federate while discovering object instance");
420 SGSharedPtr<HLAObjectInstance> objectInstance = createObjectInstance(rtiObjectInstance->getName());
421 if (!objectInstance.valid()) {
422 SG_LOG(SG_NETWORK, SG_INFO, "RTI: could not create new object instance for discovered \""
423 << rtiObjectInstance->getName() << "\" object");
426 SG_LOG(SG_NETWORK, SG_INFO, "RTI: create new object instance for discovered \""
427 << rtiObjectInstance->getName() << "\" object");
428 objectInstance->_setRTIObjectInstance(rtiObjectInstance);
429 if (!federate->_insertObjectInstance(objectInstance)) {
430 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not insert new object instance for discovered \""
431 << rtiObjectInstance->getName() << "\" object");
434 objectInstance->discoverInstance(tag);
435 objectInstance->createAttributeDataElements();
439 HLAObjectClass::_removeInstance(HLAObjectInstance& objectInstance, const RTIData& tag)
441 SGSharedPtr<HLAFederate> federate = _federate.lock();
442 if (!federate.valid()) {
443 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not find parent federate while removing object instance");
446 SG_LOG(SG_NETWORK, SG_INFO, "RTI: remove object instance \"" << objectInstance.getName() << "\"");
447 objectInstance.removeInstance(tag);
448 federate->_eraseObjectInstance(objectInstance.getName());
452 HLAObjectClass::_registerInstance(HLAObjectInstance* objectInstance)
454 SGSharedPtr<HLAFederate> federate = _federate.lock();
455 if (!federate.valid()) {
456 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not find parent federate while registering object instance");
461 // We can only register object instances with a valid name at the rti.
462 // So, we cannot do that at HLAObjectInstance creation time.
463 if (!federate->_insertObjectInstance(objectInstance)) {
464 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not insert new object instance \""
465 << objectInstance->getName() << "\" object");
468 registerInstance(*objectInstance);
469 objectInstance->createAttributeDataElements();
473 HLAObjectClass::_deleteInstance(HLAObjectInstance& objectInstance)
475 SGSharedPtr<HLAFederate> federate = _federate.lock();
476 if (!federate.valid()) {
477 SG_LOG(SG_NETWORK, SG_ALERT, "RTI: could not find parent federate while deleting object instance");
480 deleteInstance(objectInstance);
481 federate->_eraseObjectInstance(objectInstance.getName());
485 HLAObjectClass::_startRegistration()
487 if (_registrationCallback.valid())
488 _registrationCallback->startRegistration(*this);
494 HLAObjectClass::_stopRegistration()
496 if (_registrationCallback.valid())
497 _registrationCallback->stopRegistration(*this);
502 } // namespace simgear