SimulatorInterface.h

Go to the documentation of this file.

/*

License

Menge
Copyright © and trademark ™ 2012-14 University of North Carolina at Chapel Hill. 
All rights reserved.

Permission to use, copy, modify, and distribute this software and its documentation 
for educational, research, and non-profit purposes, without fee, and without a 
written agreement is hereby granted, provided that the above copyright notice, 
this paragraph, and the following four paragraphs appear in all copies.

This software program and documentation are copyrighted by the University of North 
Carolina at Chapel Hill. The software program and documentation are supplied "as is," 
without any accompanying services from the University of North Carolina at Chapel 
Hill or the authors. The University of North Carolina at Chapel Hill and the 
authors do not warrant that the operation of the program will be uninterrupted 
or error-free. The end-user understands that the program was developed for research 
purposes and is advised not to rely exclusively on the program for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS 
BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL 
DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS 
DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY 
DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY 
OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND 
THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS 
TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu

*/

#ifndef __SIMULATOR_INTERFACE_H__
#define __SIMULATOR_INTERFACE_H__

#include "CoreConfig.h"
#include "XMLSimulatorBase.h"
#include "Math/Vector2.h"
using namespace Menge::Math;
#include <vector>
#include "Core.h"

namespace Menge {

    namespace Agents {
        // forward declaration
        class BaseAgent;
        class SpatialQuery;
        class Obstacle;
        class Elevation;

        class MENGE_API SimulatorInterface: public XMLSimulatorBase {
        public:
            SimulatorInterface();

            virtual ~SimulatorInterface();

            virtual size_t getNumAgents() const = 0;

            virtual BaseAgent * getAgent( size_t agentNo ) = 0;

            virtual const BaseAgent * getAgent( size_t agentNo ) const = 0;     

            virtual void doStep() = 0;

            virtual void finalize();
            
            inline float getGlobalTime() const { return _globalTime; }
            
            inline void setTimeStep(float timeStep) { LOGICAL_TIME_STEP = timeStep; updateEffTimeStep(); }
            
            inline void setSubSteps(size_t subSteps) { SUB_STEPS = subSteps; updateEffTimeStep(); }
            
            inline float getTimeStep() const { return LOGICAL_TIME_STEP; }

            float getElevation( const BaseAgent * agent ) const;

            float getElevation( const Vector2 & point ) const;

            void setElevationInstance( Elevation * elevation );

            Elevation * getElevationInstance() { return _elevation; }

            bool hasElevation() const { return _elevation != 0x0; }

            void setSpatialQuery( SpatialQuery * spatialQuery );

            SpatialQuery *  getSpatialQuery() { return _spatialQuery;};

            bool hasSpatialQuery() const { return _spatialQuery != 0x0; }


            bool queryVisibility(const Vector2& point1, const Vector2& point2, float radius = 0.0f) const;

            inline size_t getSubSteps() const { return SUB_STEPS; }

        protected:

            void updateEffTimeStep() { SIM_TIME_STEP = TIME_STEP = LOGICAL_TIME_STEP / ( 1.f + SUB_STEPS ); }

            static float LOGICAL_TIME_STEP;

            static float TIME_STEP;

            static size_t SUB_STEPS;

            float _globalTime;  

            Elevation   *   _elevation;
            
            SpatialQuery    * _spatialQuery;
        };
    }   // namespace Agents 
}   // namespace Menge
#endif  // __SIMULATOR_INTERFACE_H__