#include <gls_mfd_menu.h>

Inheritance diagram for GlsMFDSubmenu_T< MenuItemId_t >:

Public Member Functions
	GlsMFDSubmenu_T (const std::string &name, GlsMenuDictionary &dataDict)

virtual	~GlsMFDSubmenu_T ()

MenuItemId_t	Begin ()

MenuItemId_t	End ()

bool	ShowLabel ()

std::string	Label ()

bool	Visible ()

const GlsMenuDictionary &	Attributes () const

virtual std::istream &	ReadValue (std::istream &instr)

virtual std::ostream &	WriteValue (std::ostream &outstr)

virtual void	Inc (long amount=1)

Protected Attributes
GlsMenuDictionary &	_dataDict
	Data dictionary for looking up menu variables. More...

MenuItemId_t	_begin
	Starting menu item of the submenu. More...

MenuItemId_t	_end
	Ending menu item of the submenu. More...

GlsBoolExpression	_visible
	Determines if the submenu is visible at any given instance. More...

GlsBoolExpression	_showLabel
	Determines if the submenu label should be shown at any given instance. More...

GlsMenuDictionary	_attr
	The dictionary of attributes for the group attribute. More...

Detailed Description

template<class MenuItemId_t>
class GlsMFDSubmenu_T< MenuItemId_t >

The GlsMFDSubmenu class provides support for submenus on aircraft MFDs. Normally around the bezel there will be menu items displayed. Some of the items may be grouped together as a submenu of the currently displayed menu. This class expects that the start and end item identifiers define a contiguous set of MFD menu items.

This can also act as a base class for other types of MFD submenus.

Definition at line 69 of file gls_mfd_menu.h.

Constructor & Destructor Documentation

template<class MenuItemId_t >

GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T	(	const std::string &	name,
		GlsMenuDictionary &	dataDict
	)

inline

Class constructor.

Definition at line 78 of file gls_mfd_menu.h.

References GlsMenuDataGroup::_attr, GlsMFDSubmenu_T< MenuItemId_t >::_begin, GlsMFDSubmenu_T< MenuItemId_t >::_end, GlsMFDSubmenu_T< MenuItemId_t >::_showLabel, and GlsMFDSubmenu_T< MenuItemId_t >::_visible.

template<class MenuItemId_t >

virtual GlsMFDSubmenu_T< MenuItemId_t >::~GlsMFDSubmenu_T ( )

inlinevirtual

Class destructor.

Definition at line 95 of file gls_mfd_menu.h.

Member Function Documentation

const GlsMenuDictionary& GlsMenuDataGroup::Attributes ( ) const

inlineinherited

Read attribute dictionary from an input stream.

Parameters

instr input stream to read value from.

Definition at line 80 of file gls_menu_data_group.h.

References GlsMenuDataGroup::_attr.

Referenced by GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::ReadValue().

template<class MenuItemId_t >

MenuItemId_t GlsMFDSubmenu_T< MenuItemId_t >::Begin ( )

inline

Returns the id of the beginning menu item for the submenu.

Definition at line 102 of file gls_mfd_menu.h.

References GlsMFDSubmenu_T< MenuItemId_t >::_begin.

template<class MenuItemId_t >

MenuItemId_t GlsMFDSubmenu_T< MenuItemId_t >::End ( )

inline

Returns the id of the ending menu item for the submenu.

Definition at line 109 of file gls_mfd_menu.h.

References GlsMFDSubmenu_T< MenuItemId_t >::_end.

virtual void GlsMenuData::Inc ( long amount = 1 )

virtualinherited

Increment the data item. Derived classes must override this as the default is a no-op.

Reimplemented in GlsMenuDiscrete_T< T >.

Referenced by GlsMenuSet_T< MenuType_t, DataFactory_t >::IncData().

template<class MenuItemId_t >

std::string GlsMFDSubmenu_T< MenuItemId_t >::Label ( )

inline

Returns the label of the submenu.

Definition at line 123 of file gls_mfd_menu.h.

References GlsMFDSubmenu_T< MenuItemId_t >::_dataDict, GlsMFDSubmenu_T< MenuItemId_t >::_showLabel, GlsMenuDictionary::Expand(), and GlsMFD::Name().

virtual std::istream& GlsMenuDataGroup::ReadValue ( std::istream & instr )

virtualinherited

Read attribute dictionary from an input stream.

Parameters

instr input stream to read value from.

Reimplemented in GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >, and GlsMenuDynDataGroup.

Referenced by GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::ReadValue().

template<class MenuItemId_t >

bool GlsMFDSubmenu_T< MenuItemId_t >::ShowLabel ( )

inline

Returns whether or not the submenu's label should be shown.

Definition at line 116 of file gls_mfd_menu.h.

References GlsMFDSubmenu_T< MenuItemId_t >::_showLabel.

template<class MenuItemId_t >

bool GlsMFDSubmenu_T< MenuItemId_t >::Visible ( )

inline

Returns whether or not the submenu should be shown.

Definition at line 134 of file gls_mfd_menu.h.

References GlsMFDSubmenu_T< MenuItemId_t >::_visible.

virtual std::ostream& GlsMenuDataGroup::WriteValue ( std::ostream & outstr )

virtualinherited

Read attribute dictionary from an input stream.

Parameters

instr input stream to read value from.

Field Documentation

GlsMenuDictionary GlsMenuDataGroup::_attr

protectedinherited

The dictionary of attributes for the group attribute.

Definition at line 103 of file gls_menu_data_group.h.

Referenced by GlsMenuDataGroup::Attributes(), GlsMenu_T< MenuItem_t, GlsMFD::MenuItemId_t >::GlsMenu_T(), GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::GlsMFDMenu_T(), GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T(), GlsMenuDataGroup_T< T >::Item(), GlsMenuHandlerGroup_T< Menu_t >::Item(), GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::ReadValue(), and GlsMenuItem_T< State_t >::State().

template<class MenuItemId_t >

MenuItemId_t GlsMFDSubmenu_T< MenuItemId_t >::_begin

protected

Starting menu item of the submenu.

Definition at line 143 of file gls_mfd_menu.h.

Referenced by GlsMFDSubmenu_T< MenuItemId_t >::Begin(), and GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T().

template<class MenuItemId_t >

GlsMenuDictionary& GlsMFDSubmenu_T< MenuItemId_t >::_dataDict

protected

Data dictionary for looking up menu variables.

Definition at line 140 of file gls_mfd_menu.h.

Referenced by GlsMFDSubmenu_T< MenuItemId_t >::Label().

template<class MenuItemId_t >

MenuItemId_t GlsMFDSubmenu_T< MenuItemId_t >::_end

protected

Ending menu item of the submenu.

Definition at line 146 of file gls_mfd_menu.h.

Referenced by GlsMFDSubmenu_T< MenuItemId_t >::End(), and GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T().

template<class MenuItemId_t >

GlsBoolExpression GlsMFDSubmenu_T< MenuItemId_t >::_showLabel

protected

Determines if the submenu label should be shown at any given instance.

Definition at line 152 of file gls_mfd_menu.h.

Referenced by GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T(), GlsMFDSubmenu_T< MenuItemId_t >::Label(), and GlsMFDSubmenu_T< MenuItemId_t >::ShowLabel().

template<class MenuItemId_t >

GlsBoolExpression GlsMFDSubmenu_T< MenuItemId_t >::_visible

protected

Determines if the submenu is visible at any given instance.

Definition at line 149 of file gls_mfd_menu.h.

Referenced by GlsMFDSubmenu_T< MenuItemId_t >::GlsMFDSubmenu_T(), and GlsMFDSubmenu_T< MenuItemId_t >::Visible().

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

gls_mfd_menu.h

Public Member Functions

Protected Attributes

Detailed Description

template<class MenuItemId_t> class GlsMFDSubmenu_T< MenuItemId_t >

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<class MenuItemId_t>
class GlsMFDSubmenu_T< MenuItemId_t >