Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
Nektar::Utilities::ConfigOption Struct Reference

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

#include <Module.h>

Collaboration diagram for Nektar::Utilities::ConfigOption:
Collaboration graph
[legend]

Public Member Functions

 ConfigOption (bool isBool, string defValue, string desc)
 Construct a new configuration option. More...
 
 ConfigOption ()
 
template<typename T >
as ()
 Re-interpret the value stored in value as some type using boost::lexical_cast. More...
 
 ConfigOption (bool isBool, std::string defValue, std::string desc)
 Construct a new configuration option. More...
 
 ConfigOption ()
 
template<typename 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 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...
 
string m_value
 The value of the configuration option. More...
 
string m_defValue
 Default value of the configuration option. More...
 
string m_desc
 Description of the configuration option. More...
 
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 84 of file FieldConvert/Module.h.

Constructor & Destructor Documentation

Nektar::Utilities::ConfigOption::ConfigOption ( bool  isBool,
string  defValue,
string  desc 
)
inline

Construct a new configuration option.

Parameters
isBoolTrue if the option is boolean type.
defValueDefault value of the option.
descDescription of the option.

Definition at line 93 of file FieldConvert/Module.h.

93  :
94  m_isBool(isBool), m_beenSet(false), m_value(),
string m_defValue
Default value of the configuration option.
bool isBool
True if the configuration option is a boolean (thus does not need additional arguments).
bool m_isBool
True if the configuration option is a boolean (thus does not need additional arguments).
string m_desc
Description of the configuration option.
string m_value
The value of the configuration option.
std::string defValue
Default value of the configuration option.
bool m_beenSet
True if the configuration option has been set at command line. If false, the default value will be pu...
std::string desc
Description of the configuration option.
Nektar::Utilities::ConfigOption::ConfigOption ( )
inline

Definition at line 96 of file FieldConvert/Module.h.

96  :
97  m_isBool(false), m_beenSet(false), m_value(),
98  m_defValue(), m_desc() {}
string m_defValue
Default value of the configuration option.
bool m_isBool
True if the configuration option is a boolean (thus does not need additional arguments).
string m_desc
Description of the configuration option.
string m_value
The value of the configuration option.
bool m_beenSet
True if the configuration option has been set at command line. If false, the default value will be pu...
Nektar::Utilities::ConfigOption::ConfigOption ( bool  isBool,
std::string  defValue,
std::string  desc 
)
inline

Construct a new configuration option.

Parameters
isBoolTrue if the option is boolean type.
defValueDefault value of the option.
descDescription of the option.

Definition at line 88 of file NekMesh/Module.h.

88  :
90  desc(desc) {}
bool isBool
True if the configuration option is a boolean (thus does not need additional arguments).
bool beenSet
True if the configuration option has been set at command line. If false, the default value will be pu...
std::string defValue
Default value of the configuration option.
std::string value
The value of the configuration option.
std::string desc
Description of the configuration option.
Nektar::Utilities::ConfigOption::ConfigOption ( )
inline

Definition at line 91 of file NekMesh/Module.h.

91  :
92  isBool(false), beenSet(false), value(), defValue(), desc() {}
bool isBool
True if the configuration option is a boolean (thus does not need additional arguments).
bool beenSet
True if the configuration option has been set at command line. If false, the default value will be pu...
std::string defValue
Default value of the configuration option.
std::string value
The value of the configuration option.
std::string desc
Description of the configuration option.

Member Function Documentation

template<typename T >
T Nektar::Utilities::ConfigOption::as ( )
inline

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

Definition at line 99 of file NekMesh/Module.h.

100  {
101  try
102  {
103  return boost::lexical_cast<T>(value);
104  }
105  catch(const std::exception &e)
106  {
107  std::cerr << e.what() << std::endl;
108  abort();
109  }
110  }
std::string value
The value of the configuration option.
template<typename T >
T Nektar::Utilities::ConfigOption::as ( )
inline

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

Definition at line 105 of file FieldConvert/Module.h.

106  {
107  try
108  {
109  return boost::lexical_cast<T>(m_value);
110  }
111  catch(const exception &e)
112  {
113  cerr << e.what() << endl;
114  abort();
115  }
116  }
string m_value
The value of the configuration option.
template<typename T >
bool Nektar::Utilities::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 117 of file NekMesh/Module.h.

118  {
119  bool returnval = true;
120  try
121  {
122  boost::lexical_cast<T>(value);
123  }
124  catch(const std::exception &e)
125  {
126  returnval = false;
127  }
128 
129  return returnval;
130  }
std::string value
The value of the configuration option.

Member Data Documentation

bool Nektar::Utilities::ConfigOption::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 138 of file NekMesh/Module.h.

std::string Nektar::Utilities::ConfigOption::defValue

Default value of the configuration option.

Definition at line 142 of file NekMesh/Module.h.

std::string Nektar::Utilities::ConfigOption::desc

Description of the configuration option.

Definition at line 144 of file NekMesh/Module.h.

bool Nektar::Utilities::ConfigOption::isBool

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

Definition at line 135 of file NekMesh/Module.h.

bool Nektar::Utilities::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 123 of file FieldConvert/Module.h.

string Nektar::Utilities::ConfigOption::m_defValue

Default value of the configuration option.

Definition at line 127 of file FieldConvert/Module.h.

string Nektar::Utilities::ConfigOption::m_desc

Description of the configuration option.

Definition at line 129 of file FieldConvert/Module.h.

bool Nektar::Utilities::ConfigOption::m_isBool

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

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

string Nektar::Utilities::ConfigOption::m_value

The value of the configuration option.

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

std::string Nektar::Utilities::ConfigOption::value

The value of the configuration option.

Definition at line 140 of file NekMesh/Module.h.