Nektar::FieldUtils::ConfigOption Struct Reference

Represents a command-line configuration option. More...

#include <Module.h>

Public Member Functions
	ConfigOption (bool isBool, std::string defValue, std::string desc)
	Construct a new configuration option. More...
	ConfigOption ()
template<typename T >
T	as ()
	Re-interpret the value stored in #value as some type using boost::lexical_cast. More...

Public Attributes
bool	m_isBool
	True if the configuration option is a boolean (thus does not need additional arguments). More...
bool	m_beenSet
	True if the configuration option has been set at command line. If false, the default value will be put into #value. More...
std::string	m_value
	The value of the configuration option. More...
std::string	m_defValue
	Default value of the configuration option. More...
std::string	m_desc
	Description of the configuration option. More...

Detailed Description

Represents a command-line configuration option.

Definition at line 125 of file FieldUtils/Module.h.

Constructor & Destructor Documentation

ConfigOption() [1/2]

Nektar::FieldUtils::ConfigOption::ConfigOption ( bool  isBool, std::string  defValue, std::string  desc  )

inline

Construct a new configuration option.

Parameters

isBool	True if the option is boolean type.
defValue	Default value of the option.
desc	Description of the option.

Definition at line 134 of file FieldUtils/Module.h.

        : m_isBool(isBool), m_beenSet(false), m_value(), m_defValue(defValue),
          m_desc(desc)
    {
    }

ConfigOption() [2/2]

Nektar::FieldUtils::ConfigOption::ConfigOption ( )

inline

Definition at line 139 of file FieldUtils/Module.h.

        : m_isBool(false), m_beenSet(false), m_value(), m_defValue(), m_desc()
    {
    }

Member Function Documentation

as()

template<typename T >

T Nektar::FieldUtils::ConfigOption::as ( )

inline

Re-interpret the value stored in #value as some type using boost::lexical_cast.

Definition at line 148 of file FieldUtils/Module.h.

    {
        try
        {
            return boost::lexical_cast<T>(m_value);
        }
        catch (const std::exception &e)
        {
            std::cerr << e.what() << std::endl;
            abort();
        }
    }

References m_value.

Member Data Documentation

m_beenSet

bool Nektar::FieldUtils::ConfigOption::m_beenSet

True if the configuration option has been set at command line. If false, the default value will be put into #value.

Definition at line 166 of file FieldUtils/Module.h.

m_defValue

std::string Nektar::FieldUtils::ConfigOption::m_defValue

Default value of the configuration option.

Definition at line 170 of file FieldUtils/Module.h.

m_desc

std::string Nektar::FieldUtils::ConfigOption::m_desc

Description of the configuration option.

Definition at line 172 of file FieldUtils/Module.h.

m_isBool

bool Nektar::FieldUtils::ConfigOption::m_isBool

True if the configuration option is a boolean (thus does not need additional arguments).

Definition at line 163 of file FieldUtils/Module.h.

m_value

std::string Nektar::FieldUtils::ConfigOption::m_value

The value of the configuration option.

Definition at line 168 of file FieldUtils/Module.h.

Referenced by as().