# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
"""
Defines node behaviour for PoL
"""

class NodeStateInstruction(object):
    """
    The Node State Instruction class
    """

    def __init__(self, _id, _start_step, _end_step, _node_id, _node_pol_type, _service_name, _state, _is_entry_node=False):
        """
        Init

        Args:
            _id: The node state instruction id
            _start_step: The start step of the instruction
            _end_step: The end step of the instruction
            _node_id: The id of the associated node
            _node_pol_type: The pattern of life type
            _service_name: The service name
            _state: The state (node or service)
            _is_entry_node: Indicator for entry node (default = False)
        """

        self.id = _id
        self.start_step = _start_step
        self.end_step = _end_step
        self.node_id = _node_id
        self.node_pol_type = _node_pol_type
        self.service_name = _service_name # Not used when not a service instruction
        self.state = _state     
        self.is_entry_node = _is_entry_node

    def get_start_step(self):
        """
        Gets the start step

        Returns:
             The start step
        """

        return self.start_step

    def get_end_step(self):
        """
        Gets the end step

        Returns:
             The end step
        """

        return self.end_step

    def get_node_id(self):
        """
        Gets the node ID

        Returns:
             The node ID
        """

        return self.node_id

    def get_node_pol_type(self):
        """
        Gets the node pattern of life type (enum)

        Returns:
             The node pattern of life type (enum)
        """

        return self.node_pol_type

    def get_service_name(self):
        """
        Gets the service name

        Returns:
             The service name
        """

        return self.service_name

    def get_state(self):
        """
        Gets the state (node or service)

        Returns:
             The state (node or service)
        """

        return self.state

    def get_is_entry_node(self):
        """
        Informs of entry node

        Returns:
             True if entry node
        """

        return self.is_entry_node