simSubordinateSearch.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once
class DtSimSubordinateSearch;

#include <vlutil/vlMachineTypes.h>
#include "vrfobjcore/simObject.h"

class DtSimulationServices;
class DtLocalObject;


#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtSimSubordinateSearch
{
public:

   DtSimSubordinateSearch();

   virtual ~DtSimSubordinateSearch() = 0;

   bool search(const DtUUID& search, DtLocalObject* owner, const DtSimulationServices*);

   virtual const DtString& modifier() const;

   virtual void setModifier(const DtString& modifier);

   virtual bool searchBelow(DtSimObjectReference entity, bool excludeDestroyed);

   virtual bool searchBelow(DtLocalObject* entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed);

   virtual bool searchBelow(int iForce, bool excludeDestroyed);

   virtual bool result();

   virtual bool isTopLevelEntity(const DtString& entity) const;

   virtual bool isValidEntity(DtSimObjectReference entity);
   
   virtual int forceType(const DtString& entity) const;

   virtual const DtUUID& simulationObject() const;

protected:

   virtual bool initializeSearch(DtSimObjectReference entity);
   virtual bool initializeSearch(const DtSimulationServices* vrfObjectManager);
   
   virtual bool inspectEntity(DtSimObjectReference entity);

   virtual bool isForSelfOnly() const;
   virtual bool inspectEntity(DtLocalObject* entity, DtSimObjectReference targetOfCheck);
   virtual bool inspectTopLevelEntity(DtSimObjectReference entity, bool excludeDestroyed);
   virtual bool inspectAggregateEntity(DtSimObjectReference entity, bool excludeDestroyed);

   virtual bool searchSubtree(DtSimObjectReference entity, bool excludeDestroyed);
   virtual bool searchSubtree(DtLocalObject* entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed);

   virtual bool searchSubordinates(DtSimObjectReference entity, bool excludeDestroyed);

private:
   DtSimSubordinateSearch(const DtSimSubordinateSearch& orig);

   DtSimSubordinateSearch& operator=(const DtSimSubordinateSearch& orig);

protected:
   DtString myModifier;
   bool myAnyFlag;
   bool myResult;
   DtUUID mySimulationObject;
   const DtSimulationServices* mySimulationServices;
};