search.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: search.h,v $ $Revision: 1.5 $ $State: Exp $
*******************************************************************************/

#ifndef MySearch_H_
#define MySearch_H_

#include "vrfobjcore/simSubordinateSearch.h"


class DtVrfObject;

//
//class MySearch:
//
//Instances of MySearch are used to search an entity or an entire aggregate
//structure for entities that are facing north.  If any are detected the search 
//is terminated.  Call the searchBelow() function to do the actual
//search.  Test the result by calling result().
//

class MySearch : public DtSimSubordinateSearch
{
public:
   //default constructor
   MySearch();

   //destructor
   virtual ~MySearch();

protected:
   //Function to initialize the search. Sets myAnyFlag and myResult based on
   //myModifier. If the "ANY" modifier is used, myResult is intialized to
   //false (and set to true on the first success) otherwise myResult
   //is set to true (and set to false on the first failure).
   virtual bool initializeSearch(const DtVrfObject& entity);

   //Test any and all entities to find one that is destroyed and sets
   //myResult. If the test is true and the any flag is set, it returns true
   //(which continues the search). Otherwise false is returned to end the
   //search.
   virtual bool inspectEntity(const DtVrfObject& entity);

   //Controls whether subordinates of a specified pseudo-aggregate are 
   //searched. If the "ANY" modifier was specified, it calls the base 
   //class version, otherwise it just returns false.
   virtual bool searchSubordinates(
      const DtVrfObject& pAggEntity);

protected:
   //copy constructor; not implemented
   MySearch(const MySearch& orig);

   //assignment operator; not implemented
   MySearch& operator=(const MySearch& orig);
};

#endif