Vivoe Lite 0.5.0
Lightweight GVA like HMI for military displays.
Loading...
Searching...
No Matches
gva.h File Reference
#include <array>
#include <string>
Include dependency graph for gva.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  gva::StateBase
 Base class implementing basic label state changes and checks. More...
 
class  gva::FunctionSelect
 These are the labels on the left and right of the screen. More...
 
struct  gva::FunctionSelect::Labels
 Label object. More...
 
struct  gva::FunctionKeys
 These are at the top of the screen. More...
 
struct  gva::FunctionKeys::Labels
 Label object. More...
 
class  gva::CommonTaskKeys
 Class definition of the CommonTaskKeys. More...
 
struct  gva::CommonTaskKeys::Labels
 Label object. More...
 
struct  gva::LocationType
 Enum for the location type. More...
 
struct  gva::ColourType
 Struct for the colour. More...
 
struct  gva::PointType
 Struct for the point. More...
 
struct  gva::ResolutionType
 Struct for the resolution. More...
 
struct  gva::RgbUnpackedType
 Struct for RGB values. More...
 
struct  gva::TouchType
 Struct for touch events. More...
 
struct  gva::KeyType
 This holds additional information on keys. More...
 
class  gva::EventGvaType
 Class definition of the EventGvaType. More...
 

Enumerations

enum class  gva::LocationEnum { kLocationFormatLongLat = 0 , kLocationFormatMgrs }
 Enum for the location type. More...
 
enum class  gva::ScreenMode { kModeMaintenance = 0 , kModeOperational , kModeBlackout }
 Enum for the screen mode.
 
enum class  gva::LabelModeEnum { kLabelAll , kLabelStatusOnly , kLabelMinimal }
 Enum for the label mode.
 
enum class  gva::LabelStates {
  kLabelHidden , kLabelDisabled , kLabelEnabled , kLabelEnabledSelected ,
  kLabelEnabledSelectedChanging
}
 Enum for the label states. More...
 
enum class  gva::LineType {
  kLineSolid , kLineDotted , kLineDashed , kLineDashedMedium ,
  kLineDashedLarge
}
 Enum for the label states. More...
 
enum class  gva::GvaKeyEnum {
  kKeyUnknown = 0 , kKeySituationalAwareness , kKeyWeapon , kKeyDefensiveSystems ,
  kKeySystems , kKeyDriver , kKeySpecialToRole , kKeyCommunications ,
  kKeyBattlefieldManagementSystem , kKeyF1 , kKeyF2 , kKeyF3 ,
  kKeyF4 , kKeyF5 , kKeyF6 , kKeyF7 ,
  kKeyF8 , kKeyF9 , kKeyF10 , kKeyF11 ,
  kKeyF12 , kKeyF13 , kKeyF14 , kKeyF15 ,
  kKeyF16 , kKeyF17 , kKeyF18 , kKeyF19 ,
  kKeyF20 , kKeyF21 , kKeyF22 , kKeyBlackout ,
  kKeyPower , KKeyBrightnessUp , kKeyBrightnessDown , kKeyEscape ,
  kKeyFullscreen , kKeyPlus , kKeyMinus , kKeyUpArrow ,
  kKeyDownArrow , kKeyLeftArrow , kKeyRightArrow , kKeyGreaterThan ,
  kKeyLessThen , kKeyKeyboard , kKeyPreviousLabel , kKeyNextLabel ,
  kKeyKeyboard_0 , kKeyKeyboard_1 , kKeyKeyboard_2 , kKeyKeyboard_3 ,
  kKeyKeyboard_4 , kKeyKeyboard_5 , kKeyKeyboard_6 , kKeyKeyboard_7 ,
  kKeyKeyboard_8 , kKeyKeyboard_9
}
 These are physical GVA keys around the display. More...
 
enum class  gva::GvaStatusTypes {
  kGvaSuccess = 0 , kGvaError , kGvaNetworkError , kGvaDdsError ,
  kGvaXmlError , kGvaRtpError
}
 HMI erro types, can be extended if needed.
 
enum class  gva::EventEnumType {
  kNoEvent = 0 , kKeyEventPressed , kKeyEventReleased , kTouchEvent ,
  kDdsEvent , kResizeEvent , kRedrawEvent , kWidgetUpdate
}
 Enum for the widget types. More...
 
enum class  gva::SurfaceType {
  kSurfaceNone = 0 , kSurfaceBlackout , kSurfaceFile , kSurfaceVideo ,
  kSurfaceRgb24 , kSurfaceCairo
}
 Enum for the surface types.
 
enum class  gva::GvaFunctionEnum {
  kSituationalAwareness = 0 , kWeapon , kDefensiveSystems , kSystems ,
  kDriver , KSpecialToRole , kCommunications , kBattlefieldManagementSystem ,
  kAlarmsX
}
 This is where you define all your screens, these are just the defaults.
 
enum class  gva::GvaAlarmType { kAlarmWarnings , kAlarmCaution , kAlarmAdvisory }
 These are the alarm types.
 
enum class  gva::GvaFunctionGroupEnum {
  kTop , kBottom , kLeft , kRight ,
  kAlarmTable , kKeyboard , kAlarmsIndicator , kObjectBoxes
}
 These are the functional groups.
 

Data Structure Documentation

◆ gva::FunctionSelect::Labels

struct gva::FunctionSelect::Labels

Label object.

Collaboration diagram for gva::FunctionSelect::Labels:
Collaboration graph
Data Fields
LabelStates state The label state.

◆ gva::FunctionKeys::Labels

struct gva::FunctionKeys::Labels

Label object.

Collaboration diagram for gva::FunctionKeys::Labels:
Collaboration graph
Data Fields
LabelStates state The label state.
string text The label text.
bool toggleActive True if active.
bool toggleOn toggle on bool
string toggleText1 The label text when toggled on.
string toggleText2 The label text when toggled off.

◆ gva::CommonTaskKeys::Labels

struct gva::CommonTaskKeys::Labels

Label object.

Collaboration diagram for gva::CommonTaskKeys::Labels:
Collaboration graph
Data Fields
LabelStates state_ The label state.
string text_ The label text.

Enumeration Type Documentation

◆ EventEnumType

enum class gva::EventEnumType
strong

Enum for the widget types.

Enumerator
kNoEvent 

No event.

kKeyEventPressed 

Key event.

kKeyEventReleased 

Key event released.

kTouchEvent 

Touch event.

kDdsEvent 

A DDS message.

kResizeEvent 

A resize event.

kRedrawEvent 

A redraw event.

kWidgetUpdate 

A widget update event.

◆ GvaKeyEnum

enum class gva::GvaKeyEnum
strong

These are physical GVA keys around the display.

Enumerator
kKeyUnknown 

Unknown key.

kKeySituationalAwareness 

The situational awareness key.

kKeyWeapon 

The weapon key.

kKeyDefensiveSystems 

The defensive systems key.

kKeySystems 

The systems key.

kKeyDriver 

The driver key.

kKeySpecialToRole 

The special to role key.

kKeyCommunications 

The communications key.

kKeyBattlefieldManagementSystem 

The battlefield management system key.

kKeyF1 

The Function key F1.

kKeyF2 

The Function key F2.

kKeyF3 

The Function key F3.

kKeyF4 

The Function key F4.

kKeyF5 

The Function key F5.

kKeyF6 

The Function key F6.

kKeyF7 

The Function key F7.

kKeyF8 

The Function key F8.

kKeyF9 

The Function key F9.

kKeyF10 

The Function key F10.

kKeyF11 

The Function key F11.

kKeyF12 

The Function key F12.

kKeyF13 

The Function key F13.

kKeyF14 

The Function key F14.

kKeyF15 

The Function key F15.

kKeyF16 

The Function key F16.

kKeyF17 

The Function key F17.

kKeyF18 

The Function key F18.

kKeyF19 

The Function key F19.

kKeyF20 

The Function key F20.

kKeyF21 

Special future use.

kKeyF22 

Special future use.

kKeyBlackout 

Blackout key, special to AUS-GVA screens.

kKeyPower 

Power key.

KKeyBrightnessUp 

Brightness up key.

kKeyBrightnessDown 

Brightness down key.

kKeyFullscreen 

The key full screen.

kKeyPlus 

The Plus key.

kKeyMinus 

The Minus key.

kKeyUpArrow 

The Up Arrow key.

kKeyDownArrow 

The Down Arrow key.

kKeyLeftArrow 

The Left Arrow key.

kKeyRightArrow 

The Right Arrow key.

kKeyGreaterThan 

The Greater then key.

kKeyLessThen 

The Less than key.

kKeyKeyboard 

The On Screen Keyboard key.

kKeyPreviousLabel 

The previous label key.

kKeyNextLabel 

The next label key.

kKeyKeyboard_0 

Numeric key 0.

kKeyKeyboard_1 

Numeric key 1.

kKeyKeyboard_2 

Numeric key 2.

kKeyKeyboard_3 

Numeric key 3.

kKeyKeyboard_4 

Numeric key 4.

kKeyKeyboard_5 

Numeric key 5.

kKeyKeyboard_6 

Numeric key 6.

kKeyKeyboard_7 

Numeric key 7.

kKeyKeyboard_8 

Numeric key 8.

kKeyKeyboard_9 

Numeric key 9.

◆ LabelStates

enum class gva::LabelStates
strong

Enum for the label states.

Enumerator
kLabelHidden 

Screen is hidden.

kLabelDisabled 

Screen is disabled.

kLabelEnabled 

Screen is enabled.

kLabelEnabledSelected 

Screen is enabled and selected.

kLabelEnabledSelectedChanging 

Screen is enabled and selected and changing.

◆ LineType

enum class gva::LineType
strong

Enum for the label states.

Enumerator
kLineSolid 

Line is solid.

kLineDotted 

Line is dotted.

kLineDashed 

Line is dashed.

kLineDashedMedium 

Line is dashed small.

kLineDashedLarge 

Line is dashed large.

◆ LocationEnum

enum class gva::LocationEnum
strong

Enum for the location type.

Enumerated type definition