State.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 __FSMNODE_H__
#define __FSMNODE_H__

#include <vector>
#include <cassert>
#include "Transitions/Transition.h"
#include "VelocityComponents/VelComponent.h"
#include "VelocityModifiers/VelModifier.h"
#include "Actions/Action.h"
#include "FSMEnumeration.h"
#include "PrefVelocity.h"
#include "ReadersWriterLock.h"
#include "MengeException.h"
#include <set>

namespace Menge {

    namespace BFSM {

        // forward declaration
        class StateContext;
        class GoalSelector;
        class Goal;
        class FSM;

        class MENGE_API StateException : public virtual MengeException {
        public:
            StateException() : MengeException() {}      

            StateException( const std::string & s ): MengeException(s) {}

        };
        
        class StateFatalException : public StateException, public MengeFatalException {
        public:
            StateFatalException() : MengeException(), StateException(), MengeFatalException() {}

            StateFatalException( const std::string & s ): MengeException(s), StateException(), MengeFatalException() {}
        };


        class State {
            static size_t COUNT;

            static Vector2 NULL_POINT;

        public:
            State( const std::string & name );

            ~State();

            void getTasks( FSM * fsm );

            void getPrefVelocity( Agents::BaseAgent * agent, Agents::PrefVelocity &velocity );

            inline void setFinal( bool isFinal ) { _final = isFinal; }

            inline bool getFinal() const { return _final; }

            State * testTransitions( Agents::BaseAgent * agent );

            virtual void enter( Agents::BaseAgent * agent );

            virtual void leave( Agents::BaseAgent * agent );

            void addTransition( Transition * t ) { transitions_.push_back( t ); }

            void setVelComponent( VelComponent * vc ) { _velComponent = vc; }

            void addAction( Action * a ) { actions_.push_back( a ); }

            void addVelModifier( VelModifier * v ) { velModifiers_.push_back( v ); }

            size_t getID() const { return _id; }

            std::string getName() const { return _name; }

            size_t getPopulation() const;

            void setGoalSelector( GoalSelector * selector );

            GoalSelector * getGoalSelector() { return _goalSelector; }

            void clearGoalSelector();
            
            friend class StateContext;


        protected:
            State * testTransitions( Agents::BaseAgent * agent, std::set< State * > &visited );

            VelComponent * _velComponent;
            
            std::vector< Transition * > transitions_;

            std::vector< VelModifier * > velModifiers_;

            std::vector< Action * > actions_;

            bool    _final;

            GoalSelector * _goalSelector;

            HASH_MAP< size_t, Goal * >      _goals;

            std::string _name;

            size_t _id;

            ReadersWriterLock _goalLock;
        };
    }   // namespace BFSM
}   // namespace Menge

#endif  //__FSMNODE_H__