KeyBindings Class Reference

Key bindings for char and selected terms, dimensions and TODO system options. More...

#include <KeyBindings.hpp>

Static Public Member Functions
static void	Help ()
	display all key bindings More...
static std::string	GetOptstring ()
	Get the Optstring object optstring for ArgvParser. More...

Static Public Attributes
static const std::map< char, std::string >	mapDimensions
	Dimensions translation map. More...
static const std::map< char, std::string >	mapParameters
	Parameters name translation map. More...
static const std::map< char, SystemOption >	mapSystemKeys
	SystemKeys name translation map. More...
static const char	VerboseKey {'v'}
static const char	HelpKey {'h'}
static const char	QuietKey {'q'}
static const char	FilenameKey {'f'}

Detailed Description

Key bindings for char and selected terms, dimensions and TODO system options.

Member Function Documentation

GetOptstring()

static std::string KeyBindings::GetOptstring ( )

inlinestatic

Get the Optstring object optstring for ArgvParser.

Returns

std::string

Help()

static void KeyBindings::Help ( )

inlinestatic

display all key bindings

Member Data Documentation

FilenameKey

const char KeyBindings::FilenameKey {'f'}

static

HelpKey

const char KeyBindings::HelpKey {'h'}

static

mapDimensions

const std::map< char, std::string > KeyBindings::mapDimensions

static

Initial value:

{
    {'L', Dimensions::lengthName},
    {'W', Dimensions::widthName},
    {'H', Dimensions::heightName}}

Dimensions translation map.

mapParameters

const std::map< char, std::string > KeyBindings::mapParameters

static

Initial value:

{
    {'t', Spinfull::KineticTerm::name},
    {'d', Spinfull::ProxTerm::name},
    {'m', Spinfull::ChemicalTerm::name},
    {'X', Spinfull::RashbaXTerm::name},
    {'Y', Spinfull::RashbaYTerm::name},
    {'Z', Spinfull::RashbaZTerm::name},
    {'x', Spinfull::ZeemanXTerm::name},
    {'y', Spinfull::ZeemanYTerm::name},
    {'z', Spinfull::ZeemanZTerm::name}}

Parameters name translation map.

mapSystemKeys

const std::map< char, SystemOption > KeyBindings::mapSystemKeys

static

Initial value:

{
    {KeyBindings::VerboseKey, {"verbose","increase output verbosity",""}},
    {KeyBindings::FilenameKey, {"filename","select inputscript filename",":"}},
    {KeyBindings::QuietKey, {"quiet","decrease output verbosity",""}},
    {KeyBindings::HelpKey, {"help","show help page",""}}
    }

SystemKeys name translation map.

QuietKey

const char KeyBindings::QuietKey {'q'}

static

VerboseKey

const char KeyBindings::VerboseKey {'v'}

static

---

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

• Majoranapp/Majoranapp_bits/Parsers/KeyBindings.hpp