CEnumParameter Class Reference

#include <CEnumParameter.hpp>

Public Types
enum class	EParameterChannel {   Order , Enable , BaseType , Type ,   Tag , ShipyardTag , InfoDescriptions , Area ,   DeInitTimeout , AlarmGroupId , AlarmEnable , AlarmOffScan ,   AlarmPriority , AlarmActivationDelay , AlarmDeactivationDelay , AlarmInhibitionTag ,   AlarmInhibitionCondition , DigitalInverted , DigitalAlarmLimit , DigitalDelayOn ,   DigitalDelayOff , AnalogDeadBand , AnalogOffset , AnalogFactor ,   AnalogNumDecimals , AnalogMeasurementUnit , AnalogSensorType , AnalogSensorLow ,   AnalogSensorHigh , AnalogAlarmIfl , AnalogAlarmIfh , AnalogAlarmLEL ,   AnalogAlarmHEL , AnalogAlarmLLALEnable , AnalogAlarmLLAL , AnalogAlarmLALEnable ,   AnalogAlarmLAL , AnalogAlarmHALEnable , AnalogAlarmHAL , AnalogAlarmHHALEnable ,   AnalogAlarmHHAL , FunctionCode , Equipment , System ,   UnitId }
enum class	EParameterChannelWired {   TerminalXT , Cable , Wire , TerminalBoard ,   ShipyardTerminal , ShipyardElement , First = TerminalXT , Last = ShipyardElement }
enum class	EParameterUnit {   UnitId , UnitEnabled , InternalDescription , Cabinet ,   Operational , TypeDet , SerialNumber , FwVersion ,   LogicName , LogicVersion , DataProjectDate }
enum class	eUnitExtraStates { WrongTypeDetected }
enum class	EParameterTank {   TankName , TankDescription , Capacity , ContentType ,   Density , First = TankName , Last = Density }
enum class	EParameterCabinets { CabinetId , SerialNumber , Location , InternalDescription }
enum class	EParameterGroups {   GroupId , IdForLOMs , ShotName , LongName ,   Description }
enum class	EParameterStations {   StationId , ShipArea , CanBlockAck , LocalSoundOff ,   AlarmPrinterActive , AlarmPrinterDevice , PrinterActive , PrinterDevice ,   CanConfigureVolume , CanConfigureBrightness }
enum class	EParameterTankCalibrationData { SoundingHeight , Volume , First = SoundingHeight , Last = Volume }
enum class	EParameterWatchcallNodes {   NodeType , Names , Area , isChief ,   isMessRoom , Comm }

Static Public Member Functions
static std::string	getEParameterChannelName (EParameterChannel param, bool shortName=true)
static uint16_t	getEParameterChannelMaxChars (EParameterChannel param)
static uint16_t	getChannelParameterColumnWidth (CEnumParameter::EParameterChannel param)
static uint16_t	getParameterChannelNumberDecimals (EParameterChannel param)
static bool	isEParameterChannelText (EParameterChannel param)
static std::string	getChannelAreaName (iv::channels::eChannelArea area, bool shortName=true)
static std::string	getChannelSpecificTypeName (iv::channels::eChannelSpecificType type, bool shortName=true)
static std::string	getAlarmPriorityName (iv::alarms::eAlarmPriority priority, bool shortName=true)
static std::string	getDAlarmLimitName (iv::eDigitalValue dAlarmLimit, bool shortName=true)
static std::string	getEngineeringUnitsName (iv::eMeasurementUnit engUnits, bool shortName=true)
static std::string	getInhibitionConditionName (iv::channels::eInhibitionCondition inhibitionCondition, bool shortName=true)
static std::string	getSLModbusTypeName (iv::comms::modbus::eFunctionCode slModbusType, bool shortName=true)
static std::string	getSLDataCodificationName (iv::eEndianType slDataCodification, bool shortName=true)
static std::string	getSLDataTypeName (iv::eDataType slDataType, bool shortName=true)
static std::string	getNmea0183FieldTypeName (iv::comms::nmea0183::eFieldType nmeaFieldType, bool shortName=true)
static std::string	getWASensorTypeName (iv::channels::eAnalogSensorType waSensorType, bool shortName=true)
static std::string	getVerificationStatusCSSName (iv::model::diamar::eVerificationStatus verificationStatus)
	Get the CSS name for the verification status.
static iv::model::diamar::eVerificationStatus	getVerificationStatus (const std::string &verificationStatusCSSName)
static std::string	getChannelParameterValueAsString (CEnumParameter::EParameterChannel param, iv::eLanguage language, const std::shared_ptr< iv::channels::AbstractChannel > &channel, bool &isParamValidOut)
static std::string	getVerificationStatusTooltip (iv::model::diamar::eVerificationStatus verificationStatus)
static std::string	getChannelAreaTooltip (iv::channels::eChannelArea area)
static std::string	getChannelSpecificTypeTooltip (iv::channels::eChannelSpecificType type)
static std::string	getAlarmPriorityTooltip (iv::alarms::eAlarmPriority priority)
static std::string	getDAlarmLimitTooltip (iv::eDigitalValue dAlarmLimit)
static std::string	getEngineeringUnitsTooltip (iv::eMeasurementUnit engUnits)
static std::string	getInhibitionConditionTooltip (iv::channels::eInhibitionCondition inhibitionCondition)
static std::string	getSLDataCodificationTooltip (iv::eEndianType slDataCodification)
static std::string	getSLDataTypeTooltip (iv::eDataType slDataSigned)
static std::string	getWASensorTypeTooltip (iv::channels::eAnalogSensorType waSensorType)
static std::string	getNmea0183FieldTypeTooltip (iv::comms::nmea0183::eFieldType nmeaFieldType)
static std::string	getChannelParameterTooltip (bool markupFormat, const std::shared_ptr< iv::channels::AbstractChannel > &channel, const std::shared_ptr< iv::units::Unit > &unit, CEnumParameter::EParameterChannel param, iv::eLanguage language=iv::eLanguage::English)
static std::string	getTankContentTypeTooltip (iv::tanks::eTankContentsType tankContentType)
static std::string	getEParameterChannelWiredName (EParameterChannelWired param, bool shortName=true)
static std::string	getChannelWiredParameterValueAsString (const std::shared_ptr< iv::channels::AbstractChannel > &channel, uint32_t rowPosition, EParameterChannelWired param)
static std::string	getChannelWiredParameterTooltip (bool markupFormat, const std::shared_ptr< iv::channels::AbstractChannel > &channel, uint32_t rowPosition, EParameterChannelWired param)
static std::string	getEParameterUnitName (EParameterUnit param, bool shortName=true)
static uint16_t	getEParameterUnitMaxChars (EParameterUnit param)
static std::string	getUnitHeartbeatStateCssName (iv::comms::eHeartbeatState unitEditorState, bool isNotInProjectUnit)
static std::string	getUnitExtraStatesCssName (eUnitExtraStates unitExtraState, bool isNotInProjectUnit)
static std::string	getEParameterTankName (EParameterTank param, bool shortName=true)
static uint16_t	getEParameterTankMaxChars (EParameterTank param)
static uint16_t	getEParameterTankNumDecimals (EParameterTank param)
static std::string	getTankParameterValueAsString (const std::weak_ptr< iv::tanks::Tank > &tank, CEnumParameter::EParameterTank param, iv::eLanguage language)
static std::string	getCabinetParameterName (EParameterCabinets param, bool shortName=true)
static uint16_t	getCabinetParameterMaxChars (EParameterCabinets param)
static std::string	getCabinetParameterValueAsString (const iv::model::diamar::Cabinet &cabinet, CEnumParameter::EParameterCabinets param)
static std::string	getGroupParameterName (CEnumParameter::EParameterGroups param, iv::eLanguage language, bool shortName=true)
static uint16_t	getGroupParameterMaxChars (CEnumParameter::EParameterGroups param)
static uint16_t	getGroupParameterColumnWidth (CEnumParameter::EParameterGroups param)
static std::string	getGroupParameterValueAsString (const iv::model::diamar::Group &group, CEnumParameter::EParameterGroups param, iv::eLanguage language)
static std::string	getStationParameterName (CEnumParameter::EParameterStations param, bool shortName=true)
static uint16_t	getStationParameterMaxChars (CEnumParameter::EParameterStations param)
static std::string	getStationParameterValueAsString (const std::shared_ptr< iv::diamar::Station > &station, CEnumParameter::EParameterStations param)
static std::string	getEParameterTankCalibrationDataName (EParameterTankCalibrationData param, bool shortName=true)
static uint16_t	getEParameterTankCalibrationDataMaxChars (EParameterTankCalibrationData param)
static uint16_t	getEParameterTankCalibrationDataNumDecimals (EParameterTankCalibrationData param)
static std::string	getTankCalibrationDataParameterValueAsString (const std::shared_ptr< iv::tanks::SoundingData > &soundingData, EParameterTankCalibrationData param)
static std::string	getUnitTypeName (iv::units::eUnitType type, bool shortName=true, bool shorterName=false)
static std::string	getUnitParameterValueAsString (const std::shared_ptr< iv::units::Unit > &unit, CEnumParameter::EParameterUnit param)
static std::string	getUnitTypeTooltip (iv::units::eUnitType type)
static std::string	getUnitParameterTooltip (bool markupFormat, const std::shared_ptr< iv::units::Unit > &unit, CEnumParameter::EParameterUnit param)
static std::string	getWatchcallNodeParameterName (EParameterWatchcallNodes param, bool shortName=true, iv::eLanguage language=iv::eLanguage::English)
static std::string	getWatchcallNodeParameterValueAsString (const std::shared_ptr< iv::alarms::WatchcallNode > &watchcallNode, CEnumParameter::EParameterWatchcallNodes param, iv::eLanguage language=iv::eLanguage::English)
static uint16_t	getWatchcallParameterMaxChars (EParameterWatchcallNodes param)

Member Enumeration Documentation

EParameterCabinets

enum class CEnumParameter::EParameterCabinets

strong

Enumerator
CabinetId
SerialNumber
Location
InternalDescription

EParameterChannel

enum class CEnumParameter::EParameterChannel

strong

Enumerator
Order
Enable
BaseType
Type
Tag
ShipyardTag
InfoDescriptions
Area
DeInitTimeout
AlarmGroupId
AlarmEnable
AlarmOffScan
AlarmPriority
AlarmActivationDelay
AlarmDeactivationDelay
AlarmInhibitionTag
AlarmInhibitionCondition
DigitalInverted
DigitalAlarmLimit
DigitalDelayOn
DigitalDelayOff
AnalogDeadBand
AnalogOffset
AnalogFactor
AnalogNumDecimals
AnalogMeasurementUnit
AnalogSensorType
AnalogSensorLow
AnalogSensorHigh
AnalogAlarmIfl
AnalogAlarmIfh
AnalogAlarmLEL
AnalogAlarmHEL
AnalogAlarmLLALEnable
AnalogAlarmLLAL
AnalogAlarmLALEnable
AnalogAlarmLAL
AnalogAlarmHALEnable
AnalogAlarmHAL
AnalogAlarmHHALEnable
AnalogAlarmHHAL
FunctionCode
Equipment
System
UnitId

EParameterChannelWired

enum class CEnumParameter::EParameterChannelWired

strong

Enumerator
TerminalXT
Cable
Wire
TerminalBoard
ShipyardTerminal
ShipyardElement
First
Last

EParameterGroups

enum class CEnumParameter::EParameterGroups

strong

Enumerator
GroupId
IdForLOMs
ShotName
LongName
Description

EParameterStations

enum class CEnumParameter::EParameterStations

strong

Enumerator
StationId
ShipArea
CanBlockAck
LocalSoundOff
AlarmPrinterActive
AlarmPrinterDevice
PrinterActive
PrinterDevice
CanConfigureVolume
CanConfigureBrightness

EParameterTank

enum class CEnumParameter::EParameterTank

strong

Enumerator
TankName
TankDescription
Capacity
ContentType
Density
First
Last

EParameterTankCalibrationData

enum class CEnumParameter::EParameterTankCalibrationData

strong

Enumerator
SoundingHeight
Volume
First
Last

EParameterUnit

enum class CEnumParameter::EParameterUnit

strong

Enumerator
UnitId
UnitEnabled
InternalDescription
Cabinet
Operational
TypeDet
SerialNumber
FwVersion
LogicName
LogicVersion
DataProjectDate

EParameterWatchcallNodes

enum class CEnumParameter::EParameterWatchcallNodes

strong

Enumerator
NodeType
Names
Area
isChief
isMessRoom
Comm

eUnitExtraStates

enum class CEnumParameter::eUnitExtraStates

strong

Enumerator
WrongTypeDetected

Member Function Documentation

getAlarmPriorityName()

std::string CEnumParameter::getAlarmPriorityName ( iv::alarms::eAlarmPriority priority, bool shortName = true )

static

getAlarmPriorityTooltip()

std::string CEnumParameter::getAlarmPriorityTooltip ( iv::alarms::eAlarmPriority priority )

static

getCabinetParameterMaxChars()

uint16_t CEnumParameter::getCabinetParameterMaxChars ( const CEnumParameter::EParameterCabinets param )

static

getCabinetParameterName()

std::string CEnumParameter::getCabinetParameterName ( const CEnumParameter::EParameterCabinets param, bool shortName = true )

static

getCabinetParameterValueAsString()

std::string CEnumParameter::getCabinetParameterValueAsString ( const iv::model::diamar::Cabinet & cabinet, CEnumParameter::EParameterCabinets param )

static

getChannelAreaName()

std::string CEnumParameter::getChannelAreaName ( iv::channels::eChannelArea area, bool shortName = true )

static

getChannelAreaTooltip()

std::string CEnumParameter::getChannelAreaTooltip ( iv::channels::eChannelArea area )

static

getChannelParameterColumnWidth()

uint16_t CEnumParameter::getChannelParameterColumnWidth ( CEnumParameter::EParameterChannel param )

static

getChannelParameterTooltip()

std::string CEnumParameter::getChannelParameterTooltip ( bool markupFormat, const std::shared_ptr< iv::channels::AbstractChannel > & channel, const std::shared_ptr< iv::units::Unit > & unit, CEnumParameter::EParameterChannel param, iv::eLanguage language = iv::eLanguage::English )

static

getChannelParameterValueAsString()

std::string CEnumParameter::getChannelParameterValueAsString ( CEnumParameter::EParameterChannel param, iv::eLanguage language, const std::shared_ptr< iv::channels::AbstractChannel > & channel, bool & isParamValidOut )

static

getChannelSpecificTypeName()

std::string CEnumParameter::getChannelSpecificTypeName ( iv::channels::eChannelSpecificType type, bool shortName = true )

static

getChannelSpecificTypeTooltip()

std::string CEnumParameter::getChannelSpecificTypeTooltip ( iv::channels::eChannelSpecificType type )

static

getChannelWiredParameterTooltip()

std::string CEnumParameter::getChannelWiredParameterTooltip ( bool markupFormat, const std::shared_ptr< iv::channels::AbstractChannel > & channel, uint32_t rowPosition, EParameterChannelWired param )

static

getChannelWiredParameterValueAsString()

std::string CEnumParameter::getChannelWiredParameterValueAsString ( const std::shared_ptr< iv::channels::AbstractChannel > & channel, uint32_t rowPosition, EParameterChannelWired param )

static

getDAlarmLimitName()

std::string CEnumParameter::getDAlarmLimitName ( iv::eDigitalValue dAlarmLimit, bool shortName = true )

static

getDAlarmLimitTooltip()

std::string CEnumParameter::getDAlarmLimitTooltip ( iv::eDigitalValue dAlarmLimit )

static

getEngineeringUnitsName()

std::string CEnumParameter::getEngineeringUnitsName ( iv::eMeasurementUnit engUnits, bool shortName = true )

static

getEngineeringUnitsTooltip()

std::string CEnumParameter::getEngineeringUnitsTooltip ( iv::eMeasurementUnit engUnits )

static

getEParameterChannelMaxChars()

uint16_t CEnumParameter::getEParameterChannelMaxChars ( EParameterChannel param )

static

getEParameterChannelName()

std::string CEnumParameter::getEParameterChannelName ( EParameterChannel param, bool shortName = true )

static

getEParameterChannelWiredName()

std::string CEnumParameter::getEParameterChannelWiredName ( EParameterChannelWired param, bool shortName = true )

static

getEParameterTankCalibrationDataMaxChars()

uint16_t CEnumParameter::getEParameterTankCalibrationDataMaxChars ( EParameterTankCalibrationData param )

static

getEParameterTankCalibrationDataName()

std::string CEnumParameter::getEParameterTankCalibrationDataName ( const CEnumParameter::EParameterTankCalibrationData param, bool shortName = true )

static

getEParameterTankCalibrationDataNumDecimals()

uint16_t CEnumParameter::getEParameterTankCalibrationDataNumDecimals ( EParameterTankCalibrationData param )

static

getEParameterTankMaxChars()

uint16_t CEnumParameter::getEParameterTankMaxChars ( EParameterTank param )

static

getEParameterTankName()

std::string CEnumParameter::getEParameterTankName ( EParameterTank param, bool shortName = true )

static

getEParameterTankNumDecimals()

uint16_t CEnumParameter::getEParameterTankNumDecimals ( EParameterTank param )

static

getEParameterUnitMaxChars()

uint16_t CEnumParameter::getEParameterUnitMaxChars ( EParameterUnit param )

static

getEParameterUnitName()

std::string CEnumParameter::getEParameterUnitName ( EParameterUnit param, bool shortName = true )

static

getGroupParameterColumnWidth()

uint16_t CEnumParameter::getGroupParameterColumnWidth ( CEnumParameter::EParameterGroups param )

static

getGroupParameterMaxChars()

uint16_t CEnumParameter::getGroupParameterMaxChars ( CEnumParameter::EParameterGroups param )

static

getGroupParameterName()

std::string CEnumParameter::getGroupParameterName ( CEnumParameter::EParameterGroups param, iv::eLanguage language, bool shortName = true )

static

getGroupParameterValueAsString()

std::string CEnumParameter::getGroupParameterValueAsString ( const iv::model::diamar::Group & group, CEnumParameter::EParameterGroups param, iv::eLanguage language )

static

getInhibitionConditionName()

std::string CEnumParameter::getInhibitionConditionName ( iv::channels::eInhibitionCondition inhibitionCondition, bool shortName = true )

static

getInhibitionConditionTooltip()

std::string CEnumParameter::getInhibitionConditionTooltip ( iv::channels::eInhibitionCondition inhibitionCondition )

static

getNmea0183FieldTypeName()

std::string CEnumParameter::getNmea0183FieldTypeName ( iv::comms::nmea0183::eFieldType nmeaFieldType, bool shortName = true )

static

getNmea0183FieldTypeTooltip()

std::string CEnumParameter::getNmea0183FieldTypeTooltip ( iv::comms::nmea0183::eFieldType nmeaFieldType )

static

getParameterChannelNumberDecimals()

uint16_t CEnumParameter::getParameterChannelNumberDecimals ( EParameterChannel param )

static

getSLDataCodificationName()

std::string CEnumParameter::getSLDataCodificationName ( iv::eEndianType slDataCodification, bool shortName = true )

static

getSLDataCodificationTooltip()

std::string CEnumParameter::getSLDataCodificationTooltip ( iv::eEndianType slDataCodification )

static

getSLDataTypeName()

std::string CEnumParameter::getSLDataTypeName ( iv::eDataType slDataType, bool shortName = true )

static

getSLDataTypeTooltip()

std::string CEnumParameter::getSLDataTypeTooltip ( iv::eDataType slDataSigned )

static

getSLModbusTypeName()

std::string CEnumParameter::getSLModbusTypeName ( iv::comms::modbus::eFunctionCode slModbusType, bool shortName = true )

static

getStationParameterMaxChars()

uint16_t CEnumParameter::getStationParameterMaxChars ( CEnumParameter::EParameterStations param )

static

getStationParameterName()

std::string CEnumParameter::getStationParameterName ( CEnumParameter::EParameterStations param, bool shortName = true )

static

getStationParameterValueAsString()

std::string CEnumParameter::getStationParameterValueAsString ( const std::shared_ptr< iv::diamar::Station > & station, CEnumParameter::EParameterStations param )

static

getTankCalibrationDataParameterValueAsString()

std::string CEnumParameter::getTankCalibrationDataParameterValueAsString ( const std::shared_ptr< iv::tanks::SoundingData > & soundingData, EParameterTankCalibrationData param )

static

getTankContentTypeTooltip()

std::string CEnumParameter::getTankContentTypeTooltip ( iv::tanks::eTankContentsType tankContentType )

static

getTankParameterValueAsString()

std::string CEnumParameter::getTankParameterValueAsString ( const std::weak_ptr< iv::tanks::Tank > & tank, CEnumParameter::EParameterTank param, iv::eLanguage language )

static

getUnitExtraStatesCssName()

std::string CEnumParameter::getUnitExtraStatesCssName ( const CEnumParameter::eUnitExtraStates unitExtraState, bool isNotInProjectUnit )

static

getUnitHeartbeatStateCssName()

std::string CEnumParameter::getUnitHeartbeatStateCssName ( iv::comms::eHeartbeatState unitEditorState, bool isNotInProjectUnit )

static

getUnitParameterTooltip()

std::string CEnumParameter::getUnitParameterTooltip ( bool markupFormat, const std::shared_ptr< iv::units::Unit > & unit, CEnumParameter::EParameterUnit param )

static

getUnitParameterValueAsString()

std::string CEnumParameter::getUnitParameterValueAsString ( const std::shared_ptr< iv::units::Unit > & unit, CEnumParameter::EParameterUnit param )

static

getUnitTypeName()

std::string CEnumParameter::getUnitTypeName ( iv::units::eUnitType type, bool shortName = true, bool shorterName = false )

static

getUnitTypeTooltip()

std::string CEnumParameter::getUnitTypeTooltip ( iv::units::eUnitType type )

static

getVerificationStatus()

iv::model::diamar::eVerificationStatus CEnumParameter::getVerificationStatus ( const std::string & verificationStatusCSSName )

static

getVerificationStatusCSSName()

std::string CEnumParameter::getVerificationStatusCSSName ( iv::model::diamar::eVerificationStatus verificationStatus )

static

Get the CSS name for the verification status.

Parameters

verificationStatus

Verification status

Returns

CSS name for the verification status

NotVerified: red, Verifying: blue, Verified: green.

getVerificationStatusTooltip()

std::string CEnumParameter::getVerificationStatusTooltip ( iv::model::diamar::eVerificationStatus verificationStatus )

static

getWASensorTypeName()

std::string CEnumParameter::getWASensorTypeName ( iv::channels::eAnalogSensorType waSensorType, bool shortName = true )

static

getWASensorTypeTooltip()

std::string CEnumParameter::getWASensorTypeTooltip ( iv::channels::eAnalogSensorType waSensorType )

static

getWatchcallNodeParameterName()

std::string CEnumParameter::getWatchcallNodeParameterName ( const CEnumParameter::EParameterWatchcallNodes param, bool shortName = true, iv::eLanguage language = iv::eLanguage::English )

static

getWatchcallNodeParameterValueAsString()

std::string CEnumParameter::getWatchcallNodeParameterValueAsString ( const std::shared_ptr< iv::alarms::WatchcallNode > & watchcallNode, CEnumParameter::EParameterWatchcallNodes param, iv::eLanguage language = iv::eLanguage::English )

static

getWatchcallParameterMaxChars()

uint16_t CEnumParameter::getWatchcallParameterMaxChars ( CEnumParameter::EParameterWatchcallNodes param )

static

isEParameterChannelText()

bool CEnumParameter::isEParameterChannelText ( EParameterChannel param )

static

---

The documentation for this class was generated from the following files:

• src/channels/CEnumParameter.hpp
• src/channels/CEnumParameter.cpp