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

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

    def __init__(self, _id, _start_step, _end_step, _target_node_id, _pol_initiator, _pol_type, pol_protocol, _pol_state, _pol_source_node_id, _pol_source_node_service, _pol_source_node_service_state):
        """
        Init

        Args:
            _id: The node state instruction id
            _start_step: The start step of the instruction
            _end_step: The end step of the instruction
            _target_node_id: The id of the associated node
            -pol_initiator: The way the PoL is applied (DIRECT, IER or SERVICE)
            _pol_type: The pattern of life type
            -pol_protocol: The pattern of life protocol/service affected
            _pol_state: The state (node or service)
            _pol_source_node_id: The source node Id (used for initiator type SERVICE)
            _pol_source_node_service: The source node service (used for initiator type SERVICE)
            _pol_source_node_service_state: The source node service state (used for initiator type SERVICE)
        """

        self.id = _id
        self.start_step = _start_step
        self.end_step = _end_step
        self.target_node_id = _target_node_id
        self.initiator = _pol_initiator
        self.pol_type = _pol_type
        self.service_name = pol_protocol # Not used when not a service instruction
        self.state = _pol_state
        self.source_node_id = _pol_source_node_id
        self.source_node_service = _pol_source_node_service
        self.source_node_service_state = _pol_source_node_service_state

    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_target_node_id(self):
        """
        Gets the node ID

        Returns:
             The node ID
        """

        return self.target_node_id

    def get_initiator(self):
        """
        Gets the initiator

        Returns:
             The initiator
        """

        return self.initiator

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

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

        return self.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_source_node_id(self):
        """
        Gets the source node id (used for initiator type SERVICE)

        Returns:
             The source node id
        """

        return self.source_node_id

    def get_source_node_service(self):
        """
        Gets the source node service (used for initiator type SERVICE)

        Returns:
             The source node service
        """

        return self.source_node_service

    def get_source_node_service_state(self):
        """
        Gets the source node service state (used for initiator type SERVICE)

        Returns:
             The source node service state
        """

        return self.source_node_service_state