BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum > Class Template Reference

An or conjunction is a set of transitions conditions where they are tested together with the logical or operator. If one transition condition returns true, then this entire conjunction will also return true. More...

Inheritance diagram for BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >:

Collaboration diagram for BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >:

Public Member Functions
	OrConjunction (params TransitionCondition< TBoolEnum, TTriggerEnum >[] conditions)
	Construct an or conjuction which operates as a set of boolean results with an or between each. This function sets the conditions and does error checking for null values. More...
override void	OnTransition ()
	On Transition, all conditions are notified of the transition. More...
override bool	ShouldTransition ()
	Returns true as long as one state returns that a transition should happen More...
Public Member Functions inherited from BGC.StateMachine.TransitionCondition< TBoolEnum, TTriggerEnum >
void	SetStateMachineFunctions (ITransitionDataRetriever< TBoolEnum, TTriggerEnum > stateMachine)
	Sets the required functions for the transition that it has received from the state machine. More...

Protected Member Functions
override void	StateMachineFunctionsSet ()
	Calls this function on every state to give them their required functionality. More...

Private Attributes
readonly TransitionCondition< TBoolEnum, TTriggerEnum > []	conditions
	Set of required conditions for a transition to be called More...

Additional Inherited Members
Protected Attributes inherited from BGC.StateMachine.TransitionCondition< TBoolEnum, TTriggerEnum >
ITransitionDataRetriever< TBoolEnum, TTriggerEnum >	stateMachine

Detailed Description

An or conjunction is a set of transitions conditions where they are tested together with the logical or operator. If one transition condition returns true, then this entire conjunction will also return true.

Type Constraints

TBoolEnum	:	Enum
TTriggerEnum	:	Enum

Definition at line 11 of file OrConjunction.cs.

Constructor & Destructor Documentation

OrConjunction()

BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >.OrConjunction ( params TransitionCondition< TBoolEnum, TTriggerEnum > []  conditions )

inline

Construct an or conjuction which operates as a set of boolean results with an or between each. This function sets the conditions and does error checking for null values.

Definition at line 25 of file OrConjunction.cs.

        {
            if (conditions == null)
            {
                throw new ArgumentNullException(nameof(conditions),
                    message: "OrConjunction conditions canot be null.");
            }

            for (int i = 0; i < conditions.Length; ++i)
            {
                if (conditions[i] == null)
                {
                    throw new ArgumentNullException(nameof(conditions),
                        message: $"OrConjunction conditions element {i} is null and should not be.");
                }
            }

            this.conditions = conditions;
        }

Member Function Documentation

OnTransition()

override void BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >.OnTransition ( )

inlinevirtual

On Transition, all conditions are notified of the transition.

Implements BGC.StateMachine.TransitionCondition< TBoolEnum, TTriggerEnum >.

Definition at line 48 of file OrConjunction.cs.

        {
            for (int i = 0; i < conditions.Length; ++i)
            {
                if (conditions[i].ShouldTransition())
                {
                    conditions[i].OnTransition();
                    break;
                }
            }
        }

ShouldTransition()

override bool BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >.ShouldTransition ( )

inlinevirtual

Returns true as long as one state returns that a transition should happen

Implements BGC.StateMachine.TransitionCondition< TBoolEnum, TTriggerEnum >.

Definition at line 64 of file OrConjunction.cs.

        {
            bool shouldTransition = false;
            for (int i = 0; i < conditions.Length; ++i)
            {
                if (conditions[i].ShouldTransition())
                {
                    shouldTransition = true;
                    break;
                }
            }

            return conditions.Length == 0 ? true : shouldTransition;
        }

StateMachineFunctionsSet()

override void BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >.StateMachineFunctionsSet ( )

inlineprotectedvirtual

Calls this function on every state to give them their required functionality.

Implements BGC.StateMachine.TransitionCondition< TBoolEnum, TTriggerEnum >.

Definition at line 83 of file OrConjunction.cs.

        {
            for (int i = 0; i < conditions.Length; ++i)
            {
                conditions[i].SetStateMachineFunctions(stateMachine);
            }
        }

Field Documentation

conditions

readonly TransitionCondition<TBoolEnum, TTriggerEnum> [] BGC.StateMachine.OrConjunction< TBoolEnum, TTriggerEnum >.conditions

private

Set of required conditions for a transition to be called

Definition at line 18 of file OrConjunction.cs.

---

The documentation for this class was generated from the following file:

• StateMachine/OrConjunction.cs