TriggerExpressionPrecedence.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. #ifndef TRIGGEREXPRESSIONPRECEDENCE_H_
  2. #define TRIGGEREXPRESSIONPRECEDENCE_H_
  3. #include "sc_types.h"
  4. #ifdef __cplusplus
  5. extern "C" {
  6. #endif
  7. /*! \file Header of the state machine 'TriggerExpressionPrecedence'.
  8. */
  9. /*! Enumeration of all states */
  10. typedef enum
  11. {
  12. TriggerExpressionPrecedence_TriggerExpressionPrecedence_main_region_A,
  13. TriggerExpressionPrecedence_last_state
  14. } TriggerExpressionPrecedenceStates;
  15. /*! Type definition of the data structure for the TriggerExpressionPrecedenceIface interface scope. */
  16. typedef struct
  17. {
  18. sc_boolean e1_raised;
  19. sc_boolean e2_raised;
  20. sc_boolean c1;
  21. sc_boolean c2;
  22. sc_boolean e1_transition;
  23. sc_boolean e2_transition;
  24. } TriggerExpressionPrecedenceIface;
  25. /*! Define dimension of the state configuration vector for orthogonal states. */
  26. #define TRIGGEREXPRESSIONPRECEDENCE_MAX_ORTHOGONAL_STATES 1
  27. /*!
  28. * Type definition of the data structure for the TriggerExpressionPrecedence state machine.
  29. * This data structure has to be allocated by the client code.
  30. */
  31. typedef struct
  32. {
  33. TriggerExpressionPrecedenceStates stateConfVector[TRIGGEREXPRESSIONPRECEDENCE_MAX_ORTHOGONAL_STATES];
  34. sc_ushort stateConfVectorPosition;
  35. TriggerExpressionPrecedenceIface iface;
  36. } TriggerExpressionPrecedence;
  37. /*! Initializes the TriggerExpressionPrecedence state machine data structures. Must be called before first usage.*/
  38. extern void triggerExpressionPrecedence_init(TriggerExpressionPrecedence* handle);
  39. /*! Activates the state machine */
  40. extern void triggerExpressionPrecedence_enter(TriggerExpressionPrecedence* handle);
  41. /*! Deactivates the state machine */
  42. extern void triggerExpressionPrecedence_exit(TriggerExpressionPrecedence* handle);
  43. /*! Performs a 'run to completion' step. */
  44. extern void triggerExpressionPrecedence_runCycle(TriggerExpressionPrecedence* handle);
  45. /*! Raises the in event 'e1' that is defined in the default interface scope. */
  46. extern void triggerExpressionPrecedenceIface_raise_e1(TriggerExpressionPrecedence* handle);
  47. /*! Raises the in event 'e2' that is defined in the default interface scope. */
  48. extern void triggerExpressionPrecedenceIface_raise_e2(TriggerExpressionPrecedence* handle);
  49. /*! Gets the value of the variable 'c1' that is defined in the default interface scope. */
  50. extern sc_boolean triggerExpressionPrecedenceIface_get_c1(const TriggerExpressionPrecedence* handle);
  51. /*! Sets the value of the variable 'c1' that is defined in the default interface scope. */
  52. extern void triggerExpressionPrecedenceIface_set_c1(TriggerExpressionPrecedence* handle, sc_boolean value);
  53. /*! Gets the value of the variable 'c2' that is defined in the default interface scope. */
  54. extern sc_boolean triggerExpressionPrecedenceIface_get_c2(const TriggerExpressionPrecedence* handle);
  55. /*! Sets the value of the variable 'c2' that is defined in the default interface scope. */
  56. extern void triggerExpressionPrecedenceIface_set_c2(TriggerExpressionPrecedence* handle, sc_boolean value);
  57. /*! Gets the value of the variable 'e1_transition' that is defined in the default interface scope. */
  58. extern sc_boolean triggerExpressionPrecedenceIface_get_e1_transition(const TriggerExpressionPrecedence* handle);
  59. /*! Sets the value of the variable 'e1_transition' that is defined in the default interface scope. */
  60. extern void triggerExpressionPrecedenceIface_set_e1_transition(TriggerExpressionPrecedence* handle, sc_boolean value);
  61. /*! Gets the value of the variable 'e2_transition' that is defined in the default interface scope. */
  62. extern sc_boolean triggerExpressionPrecedenceIface_get_e2_transition(const TriggerExpressionPrecedence* handle);
  63. /*! Sets the value of the variable 'e2_transition' that is defined in the default interface scope. */
  64. extern void triggerExpressionPrecedenceIface_set_e2_transition(TriggerExpressionPrecedence* handle, sc_boolean value);
  65. /*!
  66. * Checks whether the state machine is active (until 2.4.1 this method was used for states).
  67. * A state machine is active if it was entered. It is inactive if it has not been entered at all or if it has been exited.
  68. */
  69. extern sc_boolean triggerExpressionPrecedence_isActive(const TriggerExpressionPrecedence* handle);
  70. /*!
  71. * Checks if all active states are final.
  72. * If there are no active states then the state machine is considered being inactive. In this case this method returns false.
  73. */
  74. extern sc_boolean triggerExpressionPrecedence_isFinal(const TriggerExpressionPrecedence* handle);
  75. /*! Checks if the specified state is active (until 2.4.1 the used method for states was called isActive()). */
  76. extern sc_boolean triggerExpressionPrecedence_isStateActive(const TriggerExpressionPrecedence* handle, TriggerExpressionPrecedenceStates state);
  77. #ifdef __cplusplus
  78. }
  79. #endif
  80. #endif /* TRIGGEREXPRESSIONPRECEDENCE_H_ */