yakindu/test-plugins/org.yakindu.sct.generator.cpp.test/gtests/GuardedExitTest/GuardedExit.h

#ifndef GUARDEDEXIT_H_
#define GUARDEDEXIT_H_

#include "sc_types.h"
#include "StatemachineInterface.h"

/*! \file Header of the state machine 'GuardedExit'.
*/

class GuardedExit : public StatemachineInterface
{
	
	public:
		
		GuardedExit();
		
		~GuardedExit();
		
		/*! Enumeration of all states */ 
		typedef enum
		{
			main_region_A,
			main_region_B,
			GuardedExit_last_state
		} GuardedExitStates;
		
		//! Inner class for default interface scope.
		class DefaultSCI
		{
			
			public:
				/*! Raises the in event 'e' that is defined in the default interface scope. */
				void raise_e();
				
				/*! Gets the value of the variable 'guard' that is defined in the default interface scope. */
				sc_boolean get_guard() const;
				
				/*! Sets the value of the variable 'guard' that is defined in the default interface scope. */
				void set_guard(sc_boolean value);
				
				/*! Gets the value of the variable 'done' that is defined in the default interface scope. */
				sc_boolean get_done() const;
				
				/*! Sets the value of the variable 'done' that is defined in the default interface scope. */
				void set_done(sc_boolean value);
				
				
			private:
				friend class GuardedExit;
				sc_boolean e_raised;
				sc_boolean guard;
				sc_boolean done;
		};
				
		
		/*! Returns an instance of the interface class 'DefaultSCI'. */
		DefaultSCI* getDefaultSCI();
		
		/*! Raises the in event 'e' that is defined in the default interface scope. */
		void raise_e();
		
		/*! Gets the value of the variable 'guard' that is defined in the default interface scope. */
		sc_boolean get_guard() const;
		
		/*! Sets the value of the variable 'guard' that is defined in the default interface scope. */
		void set_guard(sc_boolean value);
		
		/*! Gets the value of the variable 'done' that is defined in the default interface scope. */
		sc_boolean get_done() const;
		
		/*! Sets the value of the variable 'done' that is defined in the default interface scope. */
		void set_done(sc_boolean value);
		
		
		/*
		 * Functions inherited from StatemachineInterface
		 */
		virtual void init();
		
		virtual void enter();
		
		virtual void exit();
		
		virtual void runCycle();
		
		/*!
		* Checks if the state machine is active (until 2.4.1 this method was used for states).
		* A state machine is active if it has been entered. It is inactive if it has not been entered at all or if it has been exited.
		*/
		virtual sc_boolean isActive() const;
		
		
		/*!
		* Checks if all active states are final. 
		* If there are no active states then the state machine is considered being inactive. In this case this method returns false.
		*/
		virtual sc_boolean isFinal() const;
		
		
		/*! Checks if the specified state is active (until 2.4.1 the used method for states was calles isActive()). */
		sc_boolean isStateActive(GuardedExitStates state) const;
	
	private:
	
	
		//! the maximum number of orthogonal states defines the dimension of the state configuration vector.
		static const sc_integer maxOrthogonalStates = 1;
		
		
		GuardedExitStates stateConfVector[maxOrthogonalStates];
		
		sc_ushort stateConfVectorPosition;
		
		DefaultSCI iface;
		
		// prototypes of all internal functions
		
		sc_boolean check_main_region_A_tr0_tr0();
		sc_boolean check_main_region_B_tr0_tr0();
		void effect_main_region_A_tr0();
		void effect_main_region_B_tr0();
		void exact_main_region_A();
		void enseq_main_region_A_default();
		void enseq_main_region_B_default();
		void enseq_main_region_default();
		void exseq_main_region_A();
		void exseq_main_region_B();
		void exseq_main_region();
		void react_main_region_A();
		void react_main_region_B();
		void react_main_region__entry_Default();
		void clearInEvents();
		void clearOutEvents();
		
};
#endif /* GUARDEDEXIT_H_ */