iv::mimics Namespace Reference

Namespaces
namespace	auxiliary
namespace	builders
namespace	constants
namespace	elements
namespace	elementsAutomated
namespace	elementsPms
namespace	retro
namespace	support
namespace	traits
namespace	utils

Classes
class	AbstractMimicElement
struct	Background
class	Channel
class	ChannelInterface
class	Digital
struct	HideCommandsSettings
class	IMenuOptionPanelBuilder
class	IMenuOptionRunCommand
struct	Location
struct	MenuOption
class	MimicControlMenu
class	MimicSnapshots
class	MimicsSnapshots
struct	OnlineVariable
class	OnlineVariables
class	OptionRunCommandChannel
class	PrvListenerMenuOptionClick
class	PrvMenuPanelShowChannels
class	PrvMimicElementOnlineVariablesPanel
class	Text
struct	TitleSettings

Enumerations
enum class	eMimicElementType {   Image , Line , Square , Link ,   Polyline , Text , AlarmIndicator , Breaker ,   Command , Compressor , Damper , Dial ,   Digital , Display , Fan , Generator ,   LevelBar , Motor , Propeller , Pump ,   Shaft , TextChannel , DynamicText , Tank ,   Valve , BreakerPms , GeneratorPms , OperationModesPms ,   PmsPriorities , ValveAutomated , DamperAutomated }
enum class	eZDepth { Background , Low , Normal , High }
enum class	eTitleAlign { Bottom , Left , Right , Top }
enum class	eDigitalState { NoValue , Open , Close , Undefined }
enum class	eDigitalAlarmState { NoAlarm , Alarm , Undefined }
enum class	eAlarmState {   Alarm = 1 , Warning = 2 , UnacknowledgedAlarm = 3 , UnacknowledgedWarning = 4 ,   AcknowledgedAlarm = 5 , AcknowledgedWarning = 6 , Inhibited = 7 , OffScan = 8 ,   Normal = 9 , Offline = 10 }
enum class	eMenuOptionType { Command , Panel }
enum class	eOnlineVariableType { AnalogChannel , ParameterOnline }

Functions
static AbstractComponentGUI *	prvPanelHasEditLine (iv::types::color &textColorOut)
bool	isUserFromArea (const iv::diamar::eUserProfileType userProfileType, const iv::channels::eChannelArea area)
double	minElementSize (const eMimicElementType type)
bool	prvHasBackground (const eMimicElementType type)
bool	hasTitle (const eMimicElementType type)
bool	prvHasForeground (const eMimicElementType type)
bool	prvWithScale (const eMimicElementType type)
iv::mimics::eZDepth	mimicElementDepth (const eMimicElementType type)
std::optional< iv::mimics::eAlarmState >	alarmStateToMimicAlarmState (const iv::alarms::eAlarmState alarmState, const iv::alarms::eAlarmPriority alarmPriority, const iv::alarms::eAlarmType alarmType)
std::optional< iv::mimics::eAlarmState >	mimicChannelToMimicAlarmState (const iv::mimics::Channel &channel)
std::optional< std::string >	alarmStateIcon (const iv::mimics::eAlarmState alarmState)

Enumeration Type Documentation

eAlarmState

enum class iv::mimics::eAlarmState

strong

Enumerator
Alarm
Warning
UnacknowledgedAlarm
UnacknowledgedWarning
AcknowledgedAlarm
AcknowledgedWarning
Inhibited
OffScan
Normal
Offline

eDigitalAlarmState

enum class iv::mimics::eDigitalAlarmState

strong

Enumerator
NoAlarm
Alarm
Undefined

eDigitalState

enum class iv::mimics::eDigitalState

strong

Enumerator
NoValue
Open
Close
Undefined

eMenuOptionType

enum class iv::mimics::eMenuOptionType

strong

Enumerator
Command
Panel

eMimicElementType

enum class iv::mimics::eMimicElementType

strong

Enumerator
Image
Line
Square
Link
Polyline
Text
AlarmIndicator
Breaker
Command
Compressor
Damper
Dial
Digital
Display
Fan
Generator
LevelBar
Motor
Propeller
Pump
Shaft
TextChannel
DynamicText
Tank
Valve
BreakerPms
GeneratorPms
OperationModesPms
PmsPriorities
ValveAutomated
DamperAutomated

eOnlineVariableType

enum class iv::mimics::eOnlineVariableType

strong

Enumerator
AnalogChannel
ParameterOnline

eTitleAlign

enum class iv::mimics::eTitleAlign

strong

Enumerator
Bottom
Left
Right
Top

eZDepth

enum class iv::mimics::eZDepth

strong

Enumerator
Background
Low
Normal
High

Function Documentation

alarmStateIcon()

std::optional< std::string > iv::mimics::alarmStateIcon ( const iv::mimics::eAlarmState alarmState )

inline

alarmStateToMimicAlarmState()

std::optional< iv::mimics::eAlarmState > iv::mimics::alarmStateToMimicAlarmState ( const iv::alarms::eAlarmState alarmState, const iv::alarms::eAlarmPriority alarmPriority, const iv::alarms::eAlarmType alarmType )

inline

hasTitle()

bool iv::mimics::hasTitle ( const eMimicElementType type )

inline

isUserFromArea()

bool iv::mimics::isUserFromArea ( const iv::diamar::eUserProfileType userProfileType, const iv::channels::eChannelArea area )

inline

mimicChannelToMimicAlarmState()

std::optional< iv::mimics::eAlarmState > iv::mimics::mimicChannelToMimicAlarmState ( const iv::mimics::Channel & channel )

inline

mimicElementDepth()

iv::mimics::eZDepth iv::mimics::mimicElementDepth ( const eMimicElementType type )

inline

minElementSize()

double iv::mimics::minElementSize ( const eMimicElementType type )

inline

prvHasBackground()

bool iv::mimics::prvHasBackground ( const eMimicElementType type )

inline

prvHasForeground()

bool iv::mimics::prvHasForeground ( const eMimicElementType type )

inline

prvPanelHasEditLine()

static AbstractComponentGUI * iv::mimics::prvPanelHasEditLine ( iv::types::color & textColorOut )

static

prvWithScale()

bool iv::mimics::prvWithScale ( const eMimicElementType type )

inline