VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
entInAreaSearch.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 #pragma once
9 
10 #include <vlutil/vlString.h>
11 #include <vlutil/vlMachineTypes.h>
13 #include <vrfutil/rwUUID.h>
14 
15 class DtVrfObject;
16 
25 {
26 public:
27 
30 
31  DtEntInAreaSearch(const DtUUID& area);
32 
34  virtual ~DtEntInAreaSearch();
35 
38  virtual const DtUUID& area() const;
39 
42  virtual void setArea(const DtUUID&);
43 
44  void setWarnedOnce(bool);
45  bool warnedOnce() const;
46 
47 protected:
48 
51  virtual bool initializeSearch(const DtVrfObjectManager* vrfObjectManager);
52 
54  virtual bool inspectEntity(const DtVrfObject& entity);
55 
59  virtual bool searchSubordinates(
60  const DtVrfObject& pAggEntity, bool excludeDestroyed);
61 
62 private:
65 
68 
69 protected:
70 
75 };
76 
78 {
79  myWarnedOnce = b;
80 }
81 
82 inline bool DtEntInAreaSearch::warnedOnce() const
83 {
84  return myWarnedOnce;
85 }
virtual bool initializeSearch(const DtVrfObject &entity)
Override initializeSearch if you need to do some initialization at the start of the search process...
UUID is a unique ID wrapper class.
Definition: rwUUID.h:222
virtual bool inspectEntity(const DtVrfObject &entity)
Override inspectEntity to do any tests you want to do on base entities that are found in the search...
DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application.
Definition: vrfObject.h:215
DtSimSubordinateSearch & operator=(const DtSimSubordinateSearch &orig)
assignment operator; not implemented
bool warnedOnce() const
Definition: entInAreaSearch.h:82
DtUUID myArea
Member variables.
Definition: entInAreaSearch.h:72
virtual bool searchSubordinates(const DtVrfObject &entity, bool excludeDestroyed)
SearchSubordinates will call searchSubtree on all the immediate children of a given pseudo aggregate...
DtSharedVrfObjectReference class will allocate an empty DtVrfObjectReference if one is not assigned s...
Definition: vrfObjectReference.h:102
bool myWarnedOnce
Definition: entInAreaSearch.h:74
class DtSimSubordinateSearch:
Definition: simSubordinateSearch.h:23
#define DT_DLL_vrfplanmgr
This file is used to determine how to build.
Definition: vrfplanmgrDefines.h:28
Instances of DtEntInAreaSearch are used to search the echelon entity structure for ANY entities insid...
Definition: entInAreaSearch.h:24
DtSharedVrfObjectReference myControlArea
Definition: entInAreaSearch.h:73
class DtVrfObjectManager:
Definition: vrfObjectManager.h:201
void setWarnedOnce(bool)
Definition: entInAreaSearch.h:77

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)