GSwitch Class Reference

Represents a boolean command-line switch with a description and a status. More...

#include <gswitch.h>

Public Member Functions
	GSwitch ()=default
	Default constructor.
	GSwitch (const std::string &d, bool default_status=false)
	Parameterized constructor.
void	turnOn ()
	Turns the switch on.
void	turnOff ()
	Turns the switch off.
bool	getStatus () const
	Retrieves the current status of the switch.
const std::string &	getDescription () const
	Retrieves the description of the switch.

Detailed Description

A switch is a presence-based boolean flag:

• Default: off (false)
• If specified on the command line (e.g., -gui), it becomes on (true).

Switches are stored by GOptions : and are typically used for enabling/disabling optional behaviors in an application (GUI, interactive mode, logging toggles, etc.).

Design intent:

• Lightweight value type suitable for storage in associative containers.
• Description text is meant for human-facing help output.
• Status is intentionally binary: either present (on) or absent (off).

Definition at line 27 of file gswitch.h.

Constructor & Destructor Documentation

GSwitch() [1/2]

GSwitch::GSwitch ( )

default

Constructs an empty GSwitch : with default-initialized members. This constructor is required for use in associative containers (e.g., std::map<std::string, GSwitch>), where default construction may occur during insertion/lookup.

GSwitch() [2/2]

GSwitch::GSwitch ( const std::string & d, bool default_status = false )

inline

Initializes the switch description and its default status. The status defaults to false (off) so that defining a switch never enables it implicitly; pass true to define a switch that is on by default and can be turned off explicitly (e.g. -name=false).

Parameters

d	Human-readable description of what enabling this switch does.
default_status	Initial on/off status of the switch (default: off).

Definition at line 51 of file gswitch.h.

Member Function Documentation

getDescription()

const std::string & GSwitch::getDescription ( ) const

inline

Returns

A const reference to the switch's description string.

Definition at line 84 of file gswitch.h.

getStatus()

bool GSwitch::getStatus ( ) const

inline

Returns

true if the switch is on; false otherwise.

Definition at line 77 of file gswitch.h.

turnOff()

void GSwitch::turnOff ( )

inline

Sets the internal status to false. This is typically used programmatically (not by parsing) when a system wants to enforce a default or override state.

Definition at line 70 of file gswitch.h.

turnOn()

void GSwitch::turnOn ( )

inline

Sets the internal status to true. In practice, GOptions : calls this when it encounters the switch name on the command line.

Definition at line 61 of file gswitch.h.

---

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

• gswitch.h