iv::alarms Namespace Reference

Namespaces
namespace	WatchcallIntegrity

Classes
struct	Alarm
class	AlarmRepeat
class	AlarmsManager
struct	Event
struct	FilterHistory
class	History
class	Summary
class	WatchcallManager
struct	WatchcallNode
struct	watchcallNodeStatus

Enumerations
enum class	eAlarmPriority { Alarm = 0x01 , Critical = 0x00 , Warning = 0x02 }
enum class	eAlarmState {   Inactive = 0x00 , Acknowledged = 0x01 , Active = 0x02 , Unacknowledged = 0x03 ,   Undefined = 0x04 }
enum class	eAlarmType {   Normal = 0x00 , AlarmOpen = 0x01 , AlarmClose = 0x02 , AlarmIfh = 0x03 ,   AlarmHh = 0x04 , AlarmH = 0x05 , AlarmL = 0x06 , AlarmLl = 0x07 ,   AlarmIfl = 0x08 , AlarmOffScan = 0x09 , AlarmFail = 0x0A , AlarmInh = 0x0B ,   AlarmUnk = 0x0C }
enum class	eIsNodeOnDuty : uint8_t { NoOnDuty = 0x00 , OnDuty = 0x01 }
enum class	eCallAllStatus { CallAllOff = 0x00 , CallFromEcr = 0x01 , CallFromBridge = 0x02 , CallAllUndefined = 0xFF }
enum class	eWatchState : uint8_t {   EcrOnWatch = 0x01 , EcrRequestingEcrOnWatch = 0x18 , EcrRequestingBgrOnWatch = 0x12 , BgrRequestingEcrOnWatch = 0x28 ,   BgrRequestingBgrOnWatch = 0x22 , BgrOnWatch = 0x04 , Undefined = 0x30 }
enum class	eWatchCmd : uint8_t { EcrButtonPressed = 0x0 , BrgButtonPressed = 0x1 }
enum class	eAlarmRepeatType { NoAlarmRepeat = 0x00 , OnlyDutyAlarmRepeat = 0x01 , OnDutyAndChiefAlarmRepeat = 0x02 , AllAlarmRepeat = 0x03 }
enum class	eWatchcallTechnology { WatchcallNT = 0x00 , WatchcallCan = 0x01 }
enum class	eWatchCallNodeTypes { Rms , DiamarRepeater , Slim }

Functions
static bool	prvIsCorrectArea (const iv::channels::eChannelArea channelArea, const iv::model::eShipArea shipArea)
static std::string	prvEventMessage (const std::shared_ptr< iv::channels::AbstractChannel > &channel, const iv::alarms::Alarm &alarm)
uint64_t	getAlarmCodeForSlim (const iv::alarms::eAlarmState state)
bool	isStateAlarmWithPermission (const iv::alarms::eAlarmState state)
iv::types::color	getAlarmColor (iv::alarms::eAlarmState state, iv::alarms::eAlarmType type, iv::alarms::eAlarmPriority priority)
std::string	getAlarmIcon (const iv::alarms::eAlarmState state, const iv::alarms::eAlarmType type, const iv::alarms::eAlarmPriority priority)
std::string	toString (const eAlarmType type)
std::pair< iv::alarms::eAlarmState, iv::alarms::eAlarmPriority >	getHigherPreference (iv::alarms::eAlarmState previousState, iv::alarms::eAlarmPriority previousPriority, iv::alarms::eAlarmState newState, iv::alarms::eAlarmPriority newPriority)
std::string	callAllStatusToString (iv::alarms::eCallAllStatus callAllStatus)
std::string	watchBrgEcrButtonStatusText (iv::model::eShipArea shipArea, iv::alarms::eWatchState watchState, iv::alarms::eWatchCmd watchCmd)

Enumeration Type Documentation

eAlarmPriority

enum class iv::alarms::eAlarmPriority

strong

Enumerator
Alarm
Critical
Warning

eAlarmRepeatType

enum class iv::alarms::eAlarmRepeatType

strong

Enumerator
NoAlarmRepeat
OnlyDutyAlarmRepeat
OnDutyAndChiefAlarmRepeat
AllAlarmRepeat

eAlarmState

enum class iv::alarms::eAlarmState

strong

Enumerator
Inactive
Acknowledged
Active
Unacknowledged
Undefined

eAlarmType

enum class iv::alarms::eAlarmType

strong

Enumerator
Normal
AlarmOpen
AlarmClose
AlarmIfh
AlarmHh
AlarmH
AlarmL
AlarmLl
AlarmIfl
AlarmOffScan
AlarmFail
AlarmInh
AlarmUnk

eCallAllStatus

enum class iv::alarms::eCallAllStatus

strong

Enumerator
CallAllOff
CallFromEcr
CallFromBridge
CallAllUndefined	Note : This state only exists withing the rms context, DO NOT SENT IT TO THE SLIMs IT HAS NOT BEEN TESTED

eIsNodeOnDuty

enum class iv::alarms::eIsNodeOnDuty : uint8_t

strong

Enumerator
NoOnDuty
OnDuty

eWatchCallNodeTypes

enum class iv::alarms::eWatchCallNodeTypes

strong

Enumerator
Rms
DiamarRepeater
Slim

eWatchcallTechnology

enum class iv::alarms::eWatchcallTechnology

strong

Enumerator
WatchcallNT
WatchcallCan

eWatchCmd

enum class iv::alarms::eWatchCmd : uint8_t

strong

Enumerator
EcrButtonPressed
BrgButtonPressed

eWatchState

enum class iv::alarms::eWatchState : uint8_t

strong

Enumerator
EcrOnWatch
EcrRequestingEcrOnWatch
EcrRequestingBgrOnWatch
BgrRequestingEcrOnWatch
BgrRequestingBgrOnWatch
BgrOnWatch
Undefined

Function Documentation

callAllStatusToString()

std::string iv::alarms::callAllStatusToString ( iv::alarms::eCallAllStatus callAllStatus )

inline

getAlarmCodeForSlim()

uint64_t iv::alarms::getAlarmCodeForSlim ( const iv::alarms::eAlarmState state )

inline

getAlarmColor()

iv::types::color iv::alarms::getAlarmColor ( iv::alarms::eAlarmState state, iv::alarms::eAlarmType type, iv::alarms::eAlarmPriority priority )

inline

getAlarmIcon()

std::string iv::alarms::getAlarmIcon ( const iv::alarms::eAlarmState state, const iv::alarms::eAlarmType type, const iv::alarms::eAlarmPriority priority )

inline

getHigherPreference()

std::pair< iv::alarms::eAlarmState, iv::alarms::eAlarmPriority > iv::alarms::getHigherPreference ( iv::alarms::eAlarmState previousState, iv::alarms::eAlarmPriority previousPriority, iv::alarms::eAlarmState newState, iv::alarms::eAlarmPriority newPriority )

inline

isStateAlarmWithPermission()

bool iv::alarms::isStateAlarmWithPermission ( const iv::alarms::eAlarmState state )

inline

prvEventMessage()

static std::string iv::alarms::prvEventMessage ( const std::shared_ptr< iv::channels::AbstractChannel > & channel, const iv::alarms::Alarm & alarm )

static

prvIsCorrectArea()

static bool iv::alarms::prvIsCorrectArea ( const iv::channels::eChannelArea channelArea, const iv::model::eShipArea shipArea )

static

toString()

std::string iv::alarms::toString ( const eAlarmType type )

inline

watchBrgEcrButtonStatusText()

std::string iv::alarms::watchBrgEcrButtonStatusText ( iv::model::eShipArea shipArea, iv::alarms::eWatchState watchState, iv::alarms::eWatchCmd watchCmd )

inline