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...

template<typename T >
bool	isType ()
	Interpret the value stored in value as some type using boost::lexical_cast and return true of false depending on cast. More...

Public Attributes
bool	isBool
	True if the configuration option is a boolean (thus does not need additional arguments). More...

bool	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	value
	The value of the configuration option. More...

std::string	defValue
	Default value of the configuration option. More...

std::string	desc
	Description of the configuration option. More...

Detailed Description

Represents a command-line configuration option.

Definition at line 82 of file NekMeshUtils/Module/Module.h.

Constructor & Destructor Documentation

◆ ConfigOption() [1/2]

Nektar::NekMeshUtils::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 91 of file NekMeshUtils/Module/Module.h.

                                                                       :
             isBool(isBool), beenSet(false), value(), defValue(defValue),
             desc(desc) {}

◆ ConfigOption() [2/2]

Nektar::NekMeshUtils::ConfigOption::ConfigOption ( )

inline

Definition at line 94 of file NekMeshUtils/Module/Module.h.

94 :

95 isBool(false), beenSet(false), value(), defValue(), desc() {}

Nektar::NekMeshUtils::ConfigOption::isBool

bool isBool

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

Definition: NekMeshUtils/Module/Module.h:138

Nektar::NekMeshUtils::ConfigOption::value

std::string value

The value of the configuration option.

Definition: NekMeshUtils/Module/Module.h:143

Nektar::NekMeshUtils::ConfigOption::defValue

std::string defValue

Default value of the configuration option.

Definition: NekMeshUtils/Module/Module.h:145

Nektar::NekMeshUtils::ConfigOption::desc

std::string desc

Description of the configuration option.

Definition: NekMeshUtils/Module/Module.h:147

Nektar::NekMeshUtils::ConfigOption::beenSet

bool beenSet

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

Definition: NekMeshUtils/Module/Module.h:141

Member Function Documentation

◆ as()

template<typename T >

T Nektar::NekMeshUtils::ConfigOption::as ( )

inline

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

Definition at line 102 of file NekMeshUtils/Module/Module.h.

References value.

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

◆ isType()

template<typename T >

bool Nektar::NekMeshUtils::ConfigOption::isType ( )

inline

Interpret the value stored in value as some type using boost::lexical_cast and return true of false depending on cast.

Definition at line 120 of file NekMeshUtils/Module/Module.h.

References value.

         {
             bool returnval = true;
             try
             {
                 boost::lexical_cast<T>(value);
             }
             catch(const std::exception &e)
             {
                 returnval = false;
             }
 
             return returnval;
         }