VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
vlFedTarget.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
9 #pragma once
10 
11 
12 #include <map>
13 #include <set>
14 #include <vector>
15 #include <cmath>
16 #include "vlMachineTypes.h"
17 #include <mtl/fedTargetHelper.h>
18 #include <vlutil/vlString.h>
19 #include "vlutil/vlUtil.h"
20 #include "vlutil/vlSmartPointers.h"
21 #include "vlutil/vlFedTargetTypes.h"
22 
23 #ifdef DtUSE_UTILITIES_NAMESPACE
24 namespace DtUSE_UTILITIES_NAMESPACE
25 {
26 #endif
27 
28  // Forward Declaration
29  /*class DtTimeType;
30  class DtUserSuppliedTagsType;
31  class DtSynchronizationPointsType;
32  class DtTransportationType;
33  class DtUpdateRateType;
34 
35  class DtBasicDataRepresentationType;
36  class DtSimpleDatatypeType;
37  class DtEnumeratedDatatypeType;
38  class DtArrayDatatypeType;
39  class DtFixedRecordDatatypeType;
40  class DtVariantRecordDatatypeType;
41 
42  class DtNotesType;*/
43 
44  typedef std::set<DtBoost::shared_ptr<DtUpdateRateType>, FomTypeCompare<DtUpdateRateType> > DtUpdateRateSetT;
45  typedef std::set<DtBoost::shared_ptr<DtSynchronizationPointsType>, FomTypeCompare<DtSynchronizationPointsType> > DtSyncPointSetT;
46  typedef std::set<DtBoost::shared_ptr<DtTransportationType>, FomTypeCompare<DtTransportationType> > DtTransportationSetT;
47  typedef std::set<DtBoost::shared_ptr<DtNotesType>, FomTypeCompare<DtNotesType> > DtNotesSetT;
49  typedef std::set< DtBoost::shared_ptr<DtTimeType> > DtTimeTypeSetT;
50  typedef std::set< DtBoost::shared_ptr<DtUserSuppliedTagsType> > DtUserDefinedTagsSetT;
51  typedef std::pair<DtString, DtString> ClassAttributeNamePair;
52 
53  typedef std::pair<DtString, DtString > DtNameTypePair;
54 
55  typedef std::set<DtNameTypePair> DtNameTypePairSet;
56  typedef std::pair<DtString, ClassAttributeNamePair> DtNameClassAttributeNamePair;
57  typedef std::set<DtNameClassAttributeNamePair> DtNameClassAttributeNamePairSet;
58 
59  enum DtFomType
60  {
61  DtFomInvalid = 0,
62  DtFom13 = 1,
63  DtFom1516 = 2,
64  DtFom1516E = 3
65  };
66 
67  enum DtTransportType
68  {
69  DtTransportUnknown=-1,
70  DtBest_Effort,
71  DtReliable
72  };
73 
74  enum DtOrderType
75  {
76  DtUnknownOrder=-1,
77  DtReceive,
78  DtTimestamp
79  };
80 
81  enum DtReliableType
82  {
83  DtReliableUnknown=-1,
84  Yes,
85  No
86  };
87 
90  enum DtResignAction
91  {
92  DtUnconditionallyDivestAttributes = 1,
93  DtDeleteObjects,
94  DtDeleteObjectsThanDivest,
95  DtNoAction,
96  DtCancelPendingOwnershipAcquitions,
97  DtCancelThenDeleteThenDivest
98  };
99 
100  typedef void (*fptr)(void *);
101 
106 
107  class DT_DLL_VLUTIL DtFedTarget
108  {
109  public:
110 
112  DtFedTarget();
113 
115  virtual ~DtFedTarget();
116 
118  DtFedTarget(const DtFedTarget& orig);
119 
121  DtFedTarget& operator=(const DtFedTarget& orig);
122 
124  virtual void setFomType(DtFomType type);
125  virtual DtFomType fomType();
126 
128  virtual void addSpace(const char* name);
129 
132  virtual void addDimension(const char* SpaceName, const char* dimName);
133 
135  virtual void addDimension(const char* dimName, unsigned long upperBound,
136  unsigned long defaultLowerBound, unsigned long defaultUpperBound,
137  bool excluded, const DtString& normalization);
138 
141  virtual bool addInterClass(const char* name,
142  const char* baseName, DtTransportType transport,
143  DtOrderType order, const char* space=0) = 0;
144 
147  virtual void addParameter(const char* className,
148  const char* paramName) = 0;
149 
152  virtual bool addInteractionDimension(const char* interactionName,
153  const char* dimension) = 0;
154 
157  virtual bool addObjClass(const char* name,
158  const char* baseName) = 0;
159 
162  virtual void addAttribute(const char* className, const char* attrName,
163  DtTransportType transport, DtOrderType order, DtSharingType sharing,
164  DtFomUpdateType updateType, const DtString& updateCondition,
165  DtOwnershipType ownershipType, const DtString& semantics,
166  const char* spaceName=NULL ) = 0;
167 
170  virtual void addAttribute(const char* className,
171  const char* attributeName, DtTransportType transport,
172  DtOrderType order, const char* space=0) = 0;
173 
176  virtual bool addAttributeDimension(const char* className,
177  const char* attrName, const char* dimName) = 0;
178 
179  //-------------------------------------------------------------------------
181  //-------------------------------------------------------------------------
182 
184  virtual bool autoProvide() const;
185  virtual void setAutoProvide(bool value);
186 
188  virtual bool conveyRegionDesignatorSets() const;
189  virtual void setConveyRegionDesignatorSets(bool value);
190 
192  virtual bool conveyProducingFederate() const;
193  virtual void setConveyProducingFederate(bool value);
194 
196  virtual bool attributeScopeAdvisory() const;
197  virtual void setAttributeScopeAdvisory(bool value);
198 
200  virtual bool attributeRelevanceAdvisory() const;
201  virtual void setAttributeRelevanceAdvisory(bool value);
202 
204  virtual bool objectClassRelevanceAdvisory() const;
205  virtual void setObjectClassRelevanceAdvisory(bool value);
206 
208  virtual bool interactionRelevanceAdvisory() const;
209  virtual void setInteractionRelevanceAdvisory(bool value);
210 
212  virtual bool serviceReporting() const;
213  virtual void setServiceReporting(bool value);
214 
216  virtual bool exceptionReporting() const;
217  virtual void setExceptionReporting(bool value);
218 
220  virtual bool delaySubscriptionEvaluation() const;
221  virtual void setDelaySubscriptionEvaluation(bool value);
222 
224  virtual DtResignAction automaticResignAction() const;
225  virtual void setAutomaticResignAction(DtResignAction value);
226 
227  virtual bool UpdateRateConsistencyTest( const DtUpdateRateType & updateRate );
228  virtual bool knownUpdateRate( const DtUpdateRateType & updateRate ) const;
229  virtual unsigned int numUpdateRates() const;
230  virtual void addUpdateRate( DtUpdateRateType * updateRate);
231 
232  virtual bool SyncPointConsistencyTest( const DtSynchronizationPointsType & syncName );
233  virtual bool knownSyncPoint( const DtSynchronizationPointsType & syncName ) const;
234  virtual void addSyncPoint(DtSynchronizationPointsType * syncName);
235  virtual unsigned int numSyncPoints() const;
236 
237  virtual bool knownTransportType( const DtTransportationType & transportName) const;
238  virtual bool TransportTypeConsistencyTest(const DtTransportationType & transportName);
239  virtual unsigned int numTransports() const;
240  virtual void addTransportType( DtTransportationType * transportName );
241  virtual DtTransportType transportTypeFromTransportation( const DtString & transportTypeName) const;
242 
243  virtual bool knownUserDefinedTag(const DtUserSuppliedTagsType & tagName) const;
244  virtual unsigned int numUserDefinedTags() const;
245  virtual bool userDefinedTagsSame(DtFedTarget const& module ) const;
246  virtual void addUserDefinedTag(DtUserSuppliedTagsType * tagName);
247  virtual DtMergeFomStatus mergeUserDefinedTypes(DtFedTarget const& module );
248 
249  virtual bool NoteConsistencyTest( const DtNotesType & syncName );
250  virtual bool knownNote(const DtNotesType & noteName) const;
251  virtual void addNote( DtNotesType * noteName );
252  virtual unsigned int numNotes() const;
253  virtual DtMergeFomStatus mergeSwitches(DtFedTarget const& module);
254  //bool DtFedTarget::notesSame(DtFedTarget const& module ) const;
255 
256  virtual bool knownSwitch(const DtString& switchName) const;
257  virtual unsigned int numSwitches() const;
258  virtual bool switchesSame(DtFedTarget const& module) const;
259  virtual bool switchValue(const DtString& switchName) const;
260  virtual void addSwitch(const DtString& switchName, bool switchVal);
261  virtual DtMergeFomStatus mergeNotes(DtFedTarget const& module);
262 
263  virtual bool knownTime(const DtTimeType & timeName) const;
264  virtual unsigned int numTimeTypes() const;
265  virtual bool timeTypesSame(DtFedTarget const& module ) const;
266  virtual void addTime(DtTimeType * timeName);
267  virtual DtMergeFomStatus mergeTimeTypes(DtFedTarget const& module);
268 
269 
270  virtual void addModelIdentification(const char * nameTag);
271 
272  virtual void setFomDependencies(const std::vector<DtString>& fomDependencies);
273  virtual const std::vector<DtString>& fomDependencies();
274  virtual const std::vector<DtString>& fomDependencies() const;
275 
276 
277  virtual DtMergeFomStatus mergeTarget( DtFedTarget const& module );
278  virtual DtMergeFomStatus mergeSpaces( DtFedTarget const& module );
279  virtual DtMergeFomStatus mergeObjectClasses(const DtFedTarget& module);
280  virtual DtMergeFomStatus mergeInteractionClasses(const DtFedTarget& module);
281  virtual DtMergeFomStatus mergeUpdateRates(DtFedTarget const& module);
282  virtual DtMergeFomStatus mergeSyncPoints(DtFedTarget const& module );
283  virtual DtMergeFomStatus mergeTransportTypes(DtFedTarget const& module );
284 
285 
286  public:
287 
289  static void setDefaultAutoProvide(bool onOff);
290  static bool defaultAutoProvide();
291 
293  static void setDefaultConveyRegionDesignatorSets(bool onOff);
294  static bool defaultConveyRegionDesignatorSets();
295 
297  static void setDefaultConveyProducingFederate(bool onOff);
298  static bool defaultConveyProducingFederate();
299 
301  static void setDefaultObjectClassRelevanceAdvisory(bool onOff);
302  static bool defaultObjectClassRelevanceAdvisory();
303 
305  static void setDefaultAttributeRelevanceAdvisory(bool onOff);
306  static bool defaultAttributeRelevanceAdvisory();
307 
309  static void setDefaultAttributeScopeAdvisory(bool onOff);
310  static bool defaultAttributeScopeAdvisory();
311 
313  static void setDefaultInteractionRelevanceAdvisory(bool onOff);
314  static bool defaultInteractionRelevanceAdvisory();
315 
317  static void setDefaultServiceReporting(bool onOff);
318  static bool defaultServiceReporting();
319 
321  static void setDefaultExceptionReporting(bool onOff);
322  static bool defaultExceptionReporting();
323 
325  static void setDefaultAutomaticResignAction( DtResignAction val );
326  static DtResignAction defaultAutomaticResignAction();
327 
328  // Post Merge checks
329  virtual DtMergeFomStatus postMergeCheckTarget(DtString & errorString);
330 
331  virtual bool resolveObjectModelIdentification(DtString & errorString);
332  virtual bool resolveObjectClasses(DtString & errorString, bool& fomReadError);
333  virtual bool resolveInteractionClasses(DtString & errorString, bool& fomReadError);
334  virtual bool resolveAttributes(DtString & errorString, bool& fomReadError);
335  virtual bool resolveParameters(DtString & errorString, bool& fomReadError);
336  virtual bool resolveDimensions(DtString & errorString, bool& fomReadError);
337  // Not necessary
338  virtual bool resolveTimeRepresentations(DtString & errorString);
339  // Not Necessary
340  virtual bool resolveUserSuppliedTags(DtString & errorString);
341  // Not Necessary
342  virtual bool resolveSynchronizationPoints(DtString & errorString);
343  virtual bool resolveTranportationTypes(DtString & errorString);
344  virtual bool resolveUpdateRates(DtString & errorString);
345  virtual bool resolveSwitches(DtString & errorString);
346 
347  void checkSpecificSwitch( const DtString & switchName, bool &mySwitchMissing, DtString &mySwitchesError );
348 
349  // Not necessary
350  virtual bool resolveDatatypes(DtString & errorString);
351  // Not Necessary
352  virtual bool resolveNotes(DtString & errorString);
353  // Not Necessary
354  virtual bool resolveServiceUsage(DtString & errorString);
355 
356  virtual void addBasicDataRepresentation( DtBasicDataRepresentationType * theBasicDataRepresentation );
357  virtual void addSimpleDataType( DtSimpleDatatypeType * theSimpleDataType );
358  virtual void addArrayDataType( DtArrayDatatypeType * theArrayDataType );
359  virtual void addEnumeratedDataType( DtEnumeratedDatatypeType * theEnumeratedDataType );
360  virtual void addFixedRecordDataType( DtFixedRecordDatatypeType * theFixedRecordDataType );
361  virtual void addVariantRecordDataType( DtVariantRecordDatatypeType * theVariantRecordDataType );
362  virtual bool knownModelIdentification( DtString const & nameTag ) const;
363  virtual bool modelIdentificationSame(DtFedTarget const& module ) const;
364  /*protected:*/
365  DtFomType myFomType;
366 
367  DtString myModelIdentification;
368  bool myAutoProvide;
369  bool myConveyRegionDesignatorSets;
370  bool myConveyProducingFederate;
371  bool myAttributeScopeAdvisory;
372  bool myAttributeRelevanceAdvisory;
373  bool myObjectClassRelevanceAdvisory;
374  bool myInteractionRelevanceAdvisory;
375  bool myServiceReporting;
376  bool myExceptionReporting;
377  bool myDelaySubscriptionEvaluation;
378  DtResignAction myAutomaticResignAction;
379 
380  bool isStrictMerge;
381  bool myCheckSwitches;
382 
383 
384 
385 
386  DtTimeTypeSetT myTimeTypes;
387  DtUserDefinedTagsSetT myUserDefinedTags;
388  DtSyncPointSetT mySyncPoints;
389  DtTransportationSetT myTransportTypes;
390  DtUpdateRateSetT myUpdateRates;
391  DtNotesSetT myNotes;
392 
393  std::map< DtString, bool > mySwitches;
394 
396 
397 
398  typedef std::set<DtBoost::shared_ptr<DtBasicDataRepresentationType>, FomTypeCompare<DtBasicDataRepresentationType> > DtBasicDataRepresentationSetT;
399  typedef std::set<DtBoost::shared_ptr<DtSimpleDatatypeType>, FomTypeCompare<DtSimpleDatatypeType> > DtSimpleDatatypeSetT;
400  typedef std::set<DtBoost::shared_ptr<DtEnumeratedDatatypeType>, FomTypeCompare<DtEnumeratedDatatypeType> > DtEnumeratedDatatypeSetT;
401  typedef std::set<DtBoost::shared_ptr<DtArrayDatatypeType>, FomTypeCompare<DtArrayDatatypeType> > DtArrayDatatypeSetT;
402  typedef std::set<DtBoost::shared_ptr<DtFixedRecordDatatypeType>, FomTypeCompare<DtFixedRecordDatatypeType> > DtFixedRecordDatatypeSetT;
403  typedef std::set<DtBoost::shared_ptr<DtVariantRecordDatatypeType>, FomTypeCompare<DtVariantRecordDatatypeType> > DtVariantRecordDatatypeSetT;
404 
405  DtBasicDataRepresentationSetT myBasicDataRepTypes;
406  DtSimpleDatatypeSetT mySimpleDatatypeTypes;
407  DtEnumeratedDatatypeSetT myEnumeratedDatatypeTypes;
408  DtArrayDatatypeSetT myArrayDatatypeTypes;
409  DtFixedRecordDatatypeSetT myFixedRecordDatatypeTypes;
410  DtVariantRecordDatatypeSetT myVariantRecordDatatypeTypes;
411 
412  virtual bool basicDataRepresentationConsistencyTest ( const DtBasicDataRepresentationType & theBasicDataRepresentation);
413  virtual bool knownBasicDataRepresentation( const DtBasicDataRepresentationType & theBasicDataRepresentation) const;
414  virtual bool basicDataRepresentationSame(DtFedTarget const & module) const;
415  virtual DtMergeFomStatus mergeBasicDataRepresentation(DtFedTarget const & module);
416 
417  virtual bool simpleDatatypeConsistencyTest( const DtSimpleDatatypeType & theSimpleDatatype);
418  virtual bool knownSimpleDatatype( const DtSimpleDatatypeType & theSimpleDatatype) const;
419  virtual bool simpleDatatypeSame(DtFedTarget const & module) const;
420  virtual DtMergeFomStatus mergeSimpleDatatype(DtFedTarget const & module);
421 
422  virtual bool enumeratedDatatypeConsistencyTest( const DtEnumeratedDatatypeType & theSimpleDatatype);
423  virtual bool knownEnumeratedDatatype(const DtEnumeratedDatatypeType & theEnumeratedDatatype) const;
424  virtual bool enumeratedDatatypeSame(DtFedTarget const & module) const;
425  virtual DtMergeFomStatus mergeEnumeratedDatatype(DtFedTarget const & module);
426 
427  virtual bool arrayDatatypeConsistencyTest( const DtArrayDatatypeType & DtArrayDatatypeType);
428  virtual bool knownArrayDatatype(const DtArrayDatatypeType & theArrayDatatype) const;
429  virtual bool arrayDatatypeSame(DtFedTarget const & module) const;
430  virtual DtMergeFomStatus mergeArrayDatatypeType(DtFedTarget const & module);
431 
432  virtual bool fixedRecordDatatypeConsistencyTest(const DtFixedRecordDatatypeType theFixedRecordDatatype);
433  virtual bool knownFixedRecordDatatype(const DtFixedRecordDatatypeType theFixedRecordDatatype) const;
434  virtual bool fixedRecordDatatypeSame(DtFedTarget const & module) const;
435  virtual DtMergeFomStatus mergeFixedRecordDatatype(DtFedTarget const & module);
436 
437  virtual bool variantRecordDatatypeConsistencyTest(const DtVariantRecordDatatypeType & theVariantRecordDatatype);
438  virtual bool knownVariantRecordDatatype(const DtVariantRecordDatatypeType & theVariantRecordDatatype) const;
439  virtual bool variantRecordDatatypeSame(DtFedTarget const & module) const;
440  DtMergeFomStatus mergeVariantRecordDatatype(DtFedTarget const & module);
441 
442  virtual void addUnresolvedAttributeTransportation( const DtString& transportationName, const DtString& className, const DtString& attrName );
443  virtual void removeResolvedAttributeTransportation( const DtString& transportationName, ClassAttributeNamePair classAttrPair );
444  virtual void addUnresolvedInteractionTransportation( const DtString& transportationName, const DtString& interactionName );
445  virtual void removeResolvedInteractionTransportation( const DtString& transportationName, const DtString& interactionName );
446 
447  virtual DtString& lastError();
448 
449  DtString myLastError;
450  bool myErrorFlag;
451 
452 
454  bool myMergingFomModule;
455 
456  protected:
457 
458  std::map<DtString, std::set<ClassAttributeNamePair> > unresolvedAttributeDimensions;
459  std::map<DtString, std::set<DtString> > unresolvedInteractionDimensions;
460 
461  std::map<DtString, std::set<ClassAttributeNamePair> > unresolvedAttributeTransportations;
462  std::map<DtString, std::set<DtString> > unresolvedInteractionTransportations;
463 
464  virtual void addUnresolvedAttributeDimension( const DtString& dimensionName, const DtString& className, const DtString& attrName );
465  virtual void removeResolvedAttribute( const DtString& dimensionName, ClassAttributeNamePair classAttrPair );
466  virtual void addUnresolvedInteractionDimension( const DtString& dimensionName, const DtString& interactionName );
467  virtual void removeResolvedInteractionDimension( const DtString& dimensionName, const DtString& interactionName );
468 
469 
470  virtual void mergeUnresolved(DtFedTarget const & module);
471  virtual void unionUnresolvedAttributeDimensions(const std::map<DtString, std::set<ClassAttributeNamePair> >& unresolvedAttributeDimensions);
472  virtual void unionUnresolvedInteractionDimensions(const std::map<DtString, std::set<DtString> >& unresolvedInteractionDimensions);
473 
474  virtual void unionUnresolvedAttributeTransportation(const std::map<DtString, std::set<ClassAttributeNamePair> >& unresolvedAttributetransportations);
475  virtual void unionUnresolvedInteractionTransportation(const std::map<DtString, std::set<DtString> >& unresolvedInteractiontransportations);
476 
477  virtual bool checkStringsIgnoringWhiteSpaceAndNewline(const DtString & left, const DtString & right);
478 
479  static bool theDefaultAutoProvide;
480  static bool theDefaultConveyRegionDesignatorSets;
481  static bool theDefaultConveyProducingFederate;
482  static bool theDefaultObjectClassRelevanceAdvisory;
483  static bool theDefaultAttributeRelevanceAdvisory;
484  static bool theDefaultAttributeScopeAdvisory;
485  static bool theDefaultInteractionRelevanceAdvisory;
486  static bool theDefaultServiceReporting;
487  static bool theDefaultExceptionReporting;
488  static DtResignAction theDefaultAutomaticResignAction;
489 
490  private:
491 
492  std::vector<DtString> myFomDependencies;
493 
494  };
495 
496 #ifdef DtUSE_UTILITIES_NAMESPACE
497 }
498 #endif
499 
Document ID: Generated on Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)