pipeline.src.entities.beacon_malfunctions

Classes

`BeaconStatus`	Create a collection of name/value pairs.
`BeaconMalfunctionStage`	Create a collection of name/value pairs.
`BeaconMalfunctionVesselStatus`	Create a collection of name/value pairs.
`EndOfMalfunctionReason`	Create a collection of name/value pairs.
`BeaconMalfunctionNotificationType`	Create a collection of name/value pairs.
`BeaconMalfunctionNotificationRecipientFunction`	Create a collection of name/value pairs.
`BeaconMalfunctionNotificationAddressee`
`BeaconMalfunctionToNotify`
`BeaconMalfunctionMessageToSend`
`BeaconMalfunctionNotification`

Module Contents

class pipeline.src.entities.beacon_malfunctions.BeaconStatus(*args, **kwds)[source]

Bases: 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.

ACTIVATED = 'ACTIVATED'[source]

DEACTIVATED = 'DEACTIVATED'[source]

IN_TEST = 'IN_TEST'[source]

NON_APPROVED = 'NON_APPROVED'[source]

UNSUPERVISED = 'UNSUPERVISED'[source]

static from_poseidon_status(poseidon_status: str)[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionStage(*args, **kwds)[source]

Bases: 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.

INITIAL_ENCOUNTER = 'INITIAL_ENCOUNTER'[source]

FOUR_HOUR_REPORT = 'FOUR_HOUR_REPORT'[source]

AT_QUAY = 'AT_QUAY'[source]

TARGETING_VESSEL = 'TARGETING_VESSEL'[source]

FOLLOWING = 'FOLLOWING'[source]

ARCHIVED = 'ARCHIVED'[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionVesselStatus(*args, **kwds)[source]

Bases: 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.

AT_SEA = 'AT_SEA'[source]

AT_PORT = 'AT_PORT'[source]

NO_NEWS = 'NO_NEWS'[source]

ACTIVITY_DETECTED = 'ACTIVITY_DETECTED'[source]

TECHNICAL_STOP = 'TECHNICAL_STOP'[source]

ON_SALE = 'ON_SALE'[source]

SUSPENDED_BECAUSE_UNPAID = 'SUSPENDED_BECAUSE_UNPAID'[source]

IN_FOREIGN_EEZ = 'IN_FOREIGN_EEZ'[source]

class pipeline.src.entities.beacon_malfunctions.EndOfMalfunctionReason(*args, **kwds)[source]

Bases: 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.

RESUMED_TRANSMISSION = 'RESUMED_TRANSMISSION'[source]

BEACON_DEACTIVATED_OR_UNEQUIPPED = 'BEACON_DEACTIVATED_OR_UNEQUIPPED'[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationType(*args, **kwds)[source]

Bases: 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.

MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION = 'MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION'[source]

MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON = 'MALFUNCTION_AT_SEA_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON'[source]

MALFUNCTION_AT_SEA_REMINDER = 'MALFUNCTION_AT_SEA_REMINDER'[source]

MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION = 'MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION'[source]

MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON = 'MALFUNCTION_AT_PORT_INITIAL_NOTIFICATION_UNSUPERVISED_BEACON'[source]

MALFUNCTION_AT_PORT_REMINDER = 'MALFUNCTION_AT_PORT_REMINDER'[source]

END_OF_MALFUNCTION = 'END_OF_MALFUNCTION'[source]

MALFUNCTION_NOTIFICATION_TO_FOREIGN_FMC = 'MALFUNCTION_NOTIFICATION_TO_FOREIGN_FMC'[source]

to_notification_subject_template()[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationRecipientFunction(*args, **kwds)[source]

Bases: 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.

VESSEL_CAPTAIN = 'VESSEL_CAPTAIN'[source]

VESSEL_OPERATOR = 'VESSEL_OPERATOR'[source]

SATELLITE_OPERATOR = 'SATELLITE_OPERATOR'[source]

FMC = 'FMC'[source]

FOREIGN_FMC = 'FOREIGN_FMC'[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotificationAddressee[source]

function: BeaconMalfunctionNotificationRecipientFunction[source]

name: str[source]

address_or_number: str[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionToNotify[source]

beacon_malfunction_id: int[source]

vessel_cfr_or_immat_or_ircs: str[source]

beacon_number: str[source]

vessel_name: str[source]

malfunction_start_date_utc: datetime.datetime[source]

last_position_latitude: float[source]

last_position_longitude: float[source]

notification_type: BeaconMalfunctionNotificationType[source]

vessel_emails: List[str][source]

vessel_mobile_phone: str[source]

vessel_fax: str[source]

operator_name: str[source]

operator_email: str[source]

operator_mobile_phone: str[source]

operator_fax: str[source]

satellite_operator: str[source]

satellite_operator_emails: List[str][source]

foreign_fmc_name: str[source]

foreign_fmc_emails: List[str][source]

previous_notification_datetime_utc: datetime.datetime[source]

test_mode: bool[source]

__post_init__()[source]

get_sms_addressees() → List[BeaconMalfunctionNotificationAddressee][source]

get_fax_addressees() → List[BeaconMalfunctionNotificationAddressee][source]

get_email_addressees() → List[BeaconMalfunctionNotificationAddressee][source]

get_notification_subject()[source]

get_formatted_malfunction_start_datetime_utc()[source]

replace_pandas_nat()[source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionMessageToSend[source]

message: email.message.EmailMessage[source]

beacon_malfunction_to_notify: BeaconMalfunctionToNotify[source]

communication_means: src.entities.communication_means.CommunicationMeans[source]

get_addressees() → List[BeaconMalfunctionNotificationAddressee][source]

class pipeline.src.entities.beacon_malfunctions.BeaconMalfunctionNotification[source]

beacon_malfunction_id: int[source]

date_time_utc: datetime.datetime[source]

notification_type: BeaconMalfunctionNotificationType[source]

communication_means: src.entities.communication_means.CommunicationMeans[source]

recipient_function: BeaconMalfunctionNotificationRecipientFunction[source]

recipient_name: str[source]

recipient_address_or_number: str[source]

success: bool[source]

error_message: str[source]