pipeline.src.entities.beacon_malfunctions
=========================================

.. py:module:: pipeline.src.entities.beacon_malfunctions


Classes
-------

.. autoapisummary::

   pipeline.src.entities.beacon_malfunctions.BeaconStatus
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionStage
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionVesselStatus
   pipeline.src.entities.beacon_malfunctions.EndOfMalfunctionReason
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationType
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationRecipientFunction
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationAddressee
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionToNotify
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionMessageToSend
   pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotification


Module Contents
---------------

.. py:class:: BeaconStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: ACTIVATED
      :value: 'ACTIVATED'



   .. py:attribute:: DEACTIVATED
      :value: 'DEACTIVATED'



   .. py:attribute:: IN_TEST
      :value: 'IN_TEST'



   .. py:attribute:: NON_APPROVED
      :value: 'NON_APPROVED'



   .. py:attribute:: UNSUPERVISED
      :value: 'UNSUPERVISED'



   .. py:method:: from_poseidon_status(poseidon_status: str)
      :staticmethod:



.. py:class:: BeaconMalfunctionStage(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: INITIAL_ENCOUNTER
      :value: 'INITIAL_ENCOUNTER'



   .. py:attribute:: FOUR_HOUR_REPORT
      :value: 'FOUR_HOUR_REPORT'



   .. py:attribute:: AT_QUAY
      :value: 'AT_QUAY'



   .. py:attribute:: TARGETING_VESSEL
      :value: 'TARGETING_VESSEL'



   .. py:attribute:: FOLLOWING
      :value: 'FOLLOWING'



   .. py:attribute:: ARCHIVED
      :value: 'ARCHIVED'



.. py:class:: BeaconMalfunctionVesselStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: AT_SEA
      :value: 'AT_SEA'



   .. py:attribute:: AT_PORT
      :value: 'AT_PORT'



   .. py:attribute:: NO_NEWS
      :value: 'NO_NEWS'



   .. py:attribute:: ACTIVITY_DETECTED
      :value: 'ACTIVITY_DETECTED'



   .. py:attribute:: TECHNICAL_STOP
      :value: 'TECHNICAL_STOP'



   .. py:attribute:: ON_SALE
      :value: 'ON_SALE'



   .. py:attribute:: SUSPENDED_BECAUSE_UNPAID
      :value: 'SUSPENDED_BECAUSE_UNPAID'



   .. py:attribute:: IN_FOREIGN_EEZ
      :value: 'IN_FOREIGN_EEZ'



.. py:class:: EndOfMalfunctionReason(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: RESUMED_TRANSMISSION
      :value: 'RESUMED_TRANSMISSION'



   .. py:attribute:: BEACON_DEACTIVATED_OR_UNEQUIPPED
      :value: 'BEACON_DEACTIVATED_OR_UNEQUIPPED'



.. py:class:: BeaconMalfunctionNotificationType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION
      :value: 'MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION'



   .. py:attribute:: MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON
      :value: 'MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON'



   .. py:attribute:: MALFUNCTION_AT_SEA_REMINDER
      :value: 'MALFUNCTION_AT_SEA_REMINDER'



   .. py:attribute:: MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION
      :value: 'MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION'



   .. py:attribute:: MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON
      :value: 'MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON'



   .. py:attribute:: MALFUNCTION_AT_PORT_REMINDER
      :value: 'MALFUNCTION_AT_PORT_REMINDER'



   .. py:attribute:: END_OF_MALFUNCTION
      :value: 'END_OF_MALFUNCTION'



   .. py:attribute:: MALFUNCTION_NOTIFICATION_TO_FOREIGN_FMC
      :value: 'MALFUNCTION_NOTIFICATION_TO_FOREIGN_FMC'



   .. py:method:: to_notification_subject_template()


.. py:class:: BeaconMalfunctionNotificationRecipientFunction(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: VESSEL_CAPTAIN
      :value: 'VESSEL_CAPTAIN'



   .. py:attribute:: VESSEL_OPERATOR
      :value: 'VESSEL_OPERATOR'



   .. py:attribute:: SATELLITE_OPERATOR
      :value: 'SATELLITE_OPERATOR'



   .. py:attribute:: FMC
      :value: 'FMC'



   .. py:attribute:: FOREIGN_FMC
      :value: 'FOREIGN_FMC'



.. py:class:: BeaconMalfunctionNotificationAddressee

   .. py:attribute:: function
      :type:  BeaconMalfunctionNotificationRecipientFunction


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: address_or_number
      :type:  str


.. py:class:: BeaconMalfunctionToNotify

   .. py:attribute:: beacon_malfunction_id
      :type:  int


   .. py:attribute:: vessel_cfr_or_immat_or_ircs
      :type:  str


   .. py:attribute:: beacon_number
      :type:  str


   .. py:attribute:: vessel_name
      :type:  str


   .. py:attribute:: malfunction_start_date_utc
      :type:  datetime.datetime


   .. py:attribute:: last_position_latitude
      :type:  float


   .. py:attribute:: last_position_longitude
      :type:  float


   .. py:attribute:: notification_type
      :type:  BeaconMalfunctionNotificationType


   .. py:attribute:: vessel_emails
      :type:  List[str]


   .. py:attribute:: vessel_mobile_phone
      :type:  str


   .. py:attribute:: vessel_fax
      :type:  str


   .. py:attribute:: operator_name
      :type:  str


   .. py:attribute:: operator_email
      :type:  str


   .. py:attribute:: operator_mobile_phone
      :type:  str


   .. py:attribute:: operator_fax
      :type:  str


   .. py:attribute:: satellite_operator
      :type:  str


   .. py:attribute:: satellite_operator_emails
      :type:  List[str]


   .. py:attribute:: foreign_fmc_name
      :type:  str


   .. py:attribute:: foreign_fmc_emails
      :type:  List[str]


   .. py:attribute:: previous_notification_datetime_utc
      :type:  datetime.datetime


   .. py:attribute:: test_mode
      :type:  bool


   .. py:method:: __post_init__()


   .. py:method:: get_sms_addressees() -> List[BeaconMalfunctionNotificationAddressee]


   .. py:method:: get_fax_addressees() -> List[BeaconMalfunctionNotificationAddressee]


   .. py:method:: get_email_addressees() -> List[BeaconMalfunctionNotificationAddressee]


   .. py:method:: get_notification_subject()


   .. py:method:: get_formatted_malfunction_start_datetime_utc()


   .. py:method:: replace_pandas_nat()


.. py:class:: BeaconMalfunctionMessageToSend

   .. py:attribute:: message
      :type:  email.message.EmailMessage


   .. py:attribute:: beacon_malfunction_to_notify
      :type:  BeaconMalfunctionToNotify


   .. py:attribute:: communication_means
      :type:  src.entities.communication_means.CommunicationMeans


   .. py:method:: get_addressees() -> List[BeaconMalfunctionNotificationAddressee]


.. py:class:: BeaconMalfunctionNotification

   .. py:attribute:: beacon_malfunction_id
      :type:  int


   .. py:attribute:: date_time_utc
      :type:  datetime.datetime


   .. py:attribute:: notification_type
      :type:  BeaconMalfunctionNotificationType


   .. py:attribute:: communication_means
      :type:  src.entities.communication_means.CommunicationMeans


   .. py:attribute:: recipient_function
      :type:  BeaconMalfunctionNotificationRecipientFunction


   .. py:attribute:: recipient_name
      :type:  str


   .. py:attribute:: recipient_address_or_number
      :type:  str


   .. py:attribute:: success
      :type:  bool


   .. py:attribute:: error_message
      :type:  str