the Option class allow to store the value of an option from a IPage. More...

#include <STK_Option.h>

Public Types
enum	TypeOption { unknown_ =0 , string_ , real_ , integer_ , range_ , lstring_ , lreal_ , linteger_ , lrange_ , page_ }
	A `TypeOption` is the kind of options that can read or write a program in a file. More...

Public Member Functions
	Option (String const &name, TypeOption type=string_, bool isOptional=true)
	constructor.

	Option (IPage const &page)
	Special constructor.

	Option (Option const &opt)
	Copy constructor.

	~Option ()
	Destructor.

Option &	operator= (const Option &opt)
	Assignment operator.

String const &	name () const
	name of the option.

TypeOption	type () const
	type of the option.

bool	isOptional () const
	check if the option is optional of the option.

void	setListSeparator (Char const &sep)
	set the separator to use in the list of options.

void	write (ostream &os) const
	write out the options in the output stream

void	read (istream &is)
	read in the options from the input stream.

bool	setValue (String const &str)
	Convert a string in a value.

void	setPage (IPage const &value)
	set a value from a Page.

String const &	get (String const &value) const
	get the option as a String

Real const &	get (Real const &value) const
	get the option as a Real

int	get (int const &value) const
	get the option as an int

Range const &	get (Range const &value) const
	get the option as a Range

std::list< String > const &	get (std::list< String > const &value) const
	get the option as a list of String

std::list< Real > const &	get (std::list< Real > const &value) const
	get the option as a list of Real

std::list< int > const &	get (std::list< int > const &value) const
	get the option as a list of int

std::list< Range > const &	get (std::list< Range > const &value) const
	get the option as a list of Range

IPage const &	get (IPage const &value) const
	get the option as a page

Protected Member Functions
void	set (String const &value)
	set a value from string.

void	set (Real const &value)
	set a value from a Real.

void	set (int const &value)
	set a value from an int.

void	set (Range const &value)
	set a value from a Range.

void	set (std::list< String > const &value)
	set a value from a list of String.

void	set (std::list< Real > const &value)
	set a value from a list of Real.

void	set (std::list< int > const &value)
	set a value from a list of int.

void	set (std::list< Range > const &value)
	set a value from a list of Range.

Private Member Functions
void	deleteValue ()
	Remove the value of the option.

void	setDefaultValue ()
	set a default value of the option.

Private Attributes
String	name_
	name of the option

Char	sep_
	Char used for the option list.

TypeOption	type_
	type of the option

bool	isOptional_
	`true` if the option is optional, `false` otherwise

bool	isValued_
	`true` if the option is valued, `false` otherwise.

union {

String * p_String_

Real * p_Real_

int * p_int_

Range * p_Range_

std::list< String > * p_lString_

std::list< Real > * p_lReal_

std::list< int > * p_lint_

std::list< Range > * p_lRange_

IPage * p_Page_

};
	value of the option.

Detailed Description

the Option class allow to store the value of an option from a IPage.

An Option is essentially a variant type. TODO add error message handling

Definition at line 55 of file STK_Option.h.

Constructor & Destructor Documentation

◆ Option() [1/3]

STK::Option::Option	(	String const &	name,
		TypeOption	type = `string_`,
		bool	isOptional = `true`
	)

constructor.

Parameters

name	the name of the Option
type	the type of the Option
isOptional	`true` if the parameter is optional, `false` otherwise

Definition at line 47 of file STK_Option.cpp.

              : name_(name)
              , sep_(CHAR_SEP)
              , type_(type)
              , isOptional_(isOptional)
              , isValued_(false)
              , p_String_(0)
{
  toUpperString(name_);
  setDefaultValue();
}

References name_, setDefaultValue(), and STK::toUpperString().

Referenced by Option().

◆ Option() [2/3]

STK::Option::Option ( IPage const & page )

Special constructor.

This will construct an option as a sub-page. The name of the option will be the name of the page.

Parameters

page	the page to set as option

Definition at line 63 of file STK_Option.cpp.

              : name_(page.name())
              , sep_(CHAR_SEP)
              , type_(page_)
              , isOptional_(page.isOptional())
              , isValued_(true)
              , p_Page_(page.clone())
{
  toUpperString(name_);
}

References name_, and STK::toUpperString().

◆ Option() [3/3]

STK::Option::Option ( Option const & opt )

Copy constructor.

Parameters

opt	the Option to copy

Definition at line 77 of file STK_Option.cpp.

              : name_(opt.name_)
              , sep_(opt.sep_)
              , type_(opt.type_)
              , isOptional_(opt.isOptional_)
              , isValued_(opt.isOptional_)
              , p_String_(0)
{
  // copy rhs value
  switch (type_)
  {
    case string_:
      if (opt.p_String_) set(*(opt.p_String_));
      else p_String_ = 0;
      break;
    case real_:
      if (opt.p_Real_) set(*(opt.p_Real_));
      else p_Real_ = 0;
      break;
    case integer_:
      if (opt.p_int_) set(*(opt.p_int_));
      else p_int_ = 0;
      break;
    case range_:
      if (opt.p_Range_) set(*(opt.p_Range_));
      else p_Range_ = 0;
      break;
    case lstring_:
      if (opt.p_lString_) set(*(opt.p_lString_));
      else p_lString_ = 0;
      break;
    case lreal_:
      if (opt.p_lReal_) set(*(opt.p_lReal_));
      else p_lReal_ = 0;
      break;
    case linteger_:
      if (opt.p_lint_) set(*(opt.p_lint_));
      else p_lint_ = 0;
      break;
    case lrange_:
      if (opt.p_lRange_) set(*(opt.p_lRange_));
      else p_lRange_ = 0;
      break;
    case page_:
      if (opt.p_Page_) setPage(*(opt.p_Page_));
      else p_Page_ = 0;
      break;
    case unknown_:
      STKRUNTIME_ERROR_NO_ARG(Option::Option,Unknown type option.);
      break; // avoid warning
  };
}

References integer_, linteger_, lrange_, lreal_, lstring_, Option(), p_int_, p_lint_, p_lRange_, p_lReal_, p_lString_, p_Page_, p_Range_, p_Real_, p_String_, page_, range_, real_, set(), setPage(), STKRUNTIME_ERROR_NO_ARG, string_, type(), type_, and unknown_.

◆ ~Option()

STK::Option::~Option ( )

Destructor.

Definition at line 131 of file STK_Option.cpp.

131{ deleteValue();}

STK::Option::deleteValue

void deleteValue()

Remove the value of the option.

Definition STK_Option.cpp:424

References deleteValue().

Member Function Documentation

◆ deleteValue()

void STK::Option::deleteValue ( )

private

Remove the value of the option.

Definition at line 424 of file STK_Option.cpp.

{
  switch (type_)
  {
    case string_:
      if (p_String_) delete p_String_;
      p_String_ = 0;
      break;
    case real_:
      if (p_Real_) delete p_Real_;
      p_Real_ = 0;
      break;
    case integer_:
      if (p_int_) delete p_int_;
      p_int_ = 0;
      break;
    case range_:
      if (p_Range_) delete p_Range_;
      p_Range_ = 0;
      break;
    case lstring_:
      if (p_lString_) delete p_lString_;
      p_lString_ = 0;
      break;
    case lreal_:
      if (p_lReal_) delete p_lReal_;
      p_lReal_ = 0;
      break;
    case linteger_:
      if (p_lint_) delete p_lint_;
      p_lint_ = 0;
      break;
    case lrange_:
      if (p_lRange_) delete p_lRange_;
      p_lRange_ = 0;
      break;
    case page_:
      if (p_Page_) delete p_Page_;
      p_Page_ = 0;
      break;
    default:
      break;
  };
  isValued_ = false;
}

References integer_, isValued_, linteger_, lrange_, lreal_, lstring_, p_int_, p_lint_, p_lRange_, p_lReal_, p_lString_, p_Page_, p_Range_, p_Real_, p_String_, page_, range_, real_, string_, and type_.

Referenced by set(), set(), set(), set(), set(), set(), set(), set(), setPage(), and ~Option().

◆ get() [1/9]

int STK::Option::get ( int const & value ) const

inline

get the option as an int

Parameters

value any int (will not be used)

Definition at line 170 of file STK_Option.h.

171 { return *p_int_;}

References p_int_.

◆ get() [2/9]

IPage const & STK::Option::get ( IPage const & value ) const

inline

get the option as a page

Parameters

value any page (will not be used)

Definition at line 200 of file STK_Option.h.

201 { return *p_Page_;}

References p_Page_.

◆ get() [3/9]

Range const & STK::Option::get ( Range const & value ) const

inline

get the option as a Range

Parameters

value any Range (will not be used)

Definition at line 175 of file STK_Option.h.

176 { return *p_Range_;}

References p_Range_.

◆ get() [4/9]

Real const & STK::Option::get ( Real const & value ) const

inline

get the option as a Real

Parameters

value any Real (will not be used)

Definition at line 165 of file STK_Option.h.

166 { return *p_Real_;}

References p_Real_.

◆ get() [5/9]

std::list< int > const & STK::Option::get ( std::list< int > const & value ) const

inline

get the option as a list of int

Parameters

value any list of int (will not be used)

Definition at line 190 of file STK_Option.h.

191 { return *p_lint_;}

References p_lint_.

◆ get() [6/9]

std::list< Range > const & STK::Option::get ( std::list< Range > const & value ) const

inline

get the option as a list of Range

Parameters

value any list of Range (will not be used)

Definition at line 195 of file STK_Option.h.

196 { return *p_lRange_;}

References p_lRange_.

◆ get() [7/9]

std::list< Real > const & STK::Option::get ( std::list< Real > const & value ) const

inline

get the option as a list of Real

Parameters

value any list of Real (will not be used)

Definition at line 185 of file STK_Option.h.

186 { return *p_lReal_;}

References p_lReal_.

◆ get() [8/9]

std::list< String > const & STK::Option::get ( std::list< String > const & value ) const

inline

get the option as a list of String

Parameters

value any list of String (will not be used)

Definition at line 180 of file STK_Option.h.

181 { return *p_lString_;}

References p_lString_.

◆ get() [9/9]

String const & STK::Option::get ( String const & value ) const

inline

get the option as a String

Parameters

value any String (will not be used)

Definition at line 160 of file STK_Option.h.

161 { return *p_String_;}

References p_String_.

◆ isOptional()

bool STK::Option::isOptional ( ) const

inline

check if the option is optional of the option.

Returns: ture if the option s optional, false otherwise

Definition at line 124 of file STK_Option.h.

124{ return isOptional_;}

References isOptional_.

◆ name()

String const & STK::Option::name ( ) const

inline

name of the option.

If the option is a IPage, the name have to be the keyword.

Returns: the name of the option

Definition at line 116 of file STK_Option.h.

116{ return name_;}

References name_.

◆ operator=()

Option & STK::Option::operator= ( const Option & opt )

Assignment operator.

We need to overload this operator otherwise the variant union containing the value of the Option will not be copied correctly.

Parameters

opt	the Option to copy

Returns: a reference o this

Definition at line 134 of file STK_Option.cpp.

{
  // Do the assignment operation of the members
  name_ = opt.name_;
  sep_ = opt.sep_;
  type_ = opt.type_;
  isOptional_ = opt.isOptional_;
  isValued_ = opt.isValued_;
  // copy rhs value
  switch (type_)
  {
    case string_:
      if (opt.p_String_) set(*(opt.p_String_));
      else p_String_ = 0;
      break;
    case real_:
      if (opt.p_Real_) set(*(opt.p_Real_));
      else p_Real_ = 0;
      break;
    case integer_:
      if (opt.p_int_) set(*(opt.p_int_));
      else p_int_ = 0;
      break;
    case range_:
      if (opt.p_Range_) set(*(opt.p_Range_));
      else p_Range_ = 0;
      break;
    case lstring_:
      if (opt.p_lString_) set(*(opt.p_lString_));
      else p_lString_ = 0;
      break;
    case lreal_:
      if (opt.p_lReal_) set(*(opt.p_lReal_));
      else p_lReal_ = 0;
      break;
    case linteger_:
      if (opt.p_lint_) set(*(opt.p_lint_));
      else p_lint_ = 0;
      break;
    case lrange_:
      if (opt.p_lRange_) set(*(opt.p_lRange_));
      else p_lRange_ = 0;
      break;
    case page_:
      if (opt.p_Page_) setPage(*(opt.p_Page_));
      else p_Page_ = 0;
      break;
    case unknown_:
      STKRUNTIME_ERROR_NO_ARG(Option::operator=,Unknown type option.);
      break; // avoid warning
  };
  // return this
  return *this;  // Return a reference to myself.
}

References integer_, isOptional_, isValued_, linteger_, lrange_, lreal_, lstring_, name_, p_int_, p_lint_, p_lRange_, p_lReal_, p_lString_, p_Page_, p_Range_, p_Real_, p_String_, page_, range_, real_, sep_, set(), setPage(), STKRUNTIME_ERROR_NO_ARG, string_, type(), type_, and unknown_.

◆ read()

void STK::Option::read ( istream & is )

read in the options from the input stream.

This method is only used for reading the pages options. All the other options are read outside and set using the set and setValue methods.

Parameters

is	the input stream to read

Definition at line 330 of file STK_Option.cpp.

{
  // read option value
  if (type_ == page_)
  {
      if (p_Page_)
      {
        p_Page_->read(is);
        if (!p_Page_->validate())
        { STKRUNTIME_ERROR_NO_ARG(Option::read,p_Page_->msg_error());}
      }
  };
}

References STK::IPage::msg_error(), p_Page_, page_, STK::IPage::read(), read(), STKRUNTIME_ERROR_NO_ARG, type_, and STK::IPage::validate().

Referenced by read().

◆ set() [1/8]

void STK::Option::set ( int const & value )

protected

set a value from an int.

Parameters

value the int value to set

Definition at line 367 of file STK_Option.cpp.

{
  deleteValue();
  p_int_ = new int(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_int_.

◆ set() [2/8]

void STK::Option::set ( Range const & value )

protected

set a value from a Range.

Parameters

value the Range value to set

Definition at line 377 of file STK_Option.cpp.

{
  deleteValue();
  p_Range_ = new Range(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_Range_.

◆ set() [3/8]

void STK::Option::set ( Real const & value )

protected

set a value from a Real.

Parameters

value the Real value to set

Definition at line 357 of file STK_Option.cpp.

{
  deleteValue();
  p_Real_ = new Real(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_Real_.

◆ set() [4/8]

void STK::Option::set ( std::list< int > const & value )

protected

set a value from a list of int.

Parameters

value the list of int values to set

Definition at line 407 of file STK_Option.cpp.

{
  deleteValue();
  p_lint_ = new std::list<int>(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_lint_.

◆ set() [5/8]

void STK::Option::set ( std::list< Range > const & value )

protected

set a value from a list of Range.

Parameters

value the list of Range values to set

Definition at line 416 of file STK_Option.cpp.

{
  deleteValue();
  p_lRange_ = new std::list<Range>(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_lRange_.

◆ set() [6/8]

void STK::Option::set ( std::list< Real > const & value )

protected

set a value from a list of Real.

Parameters

value the list of Real values to set

Definition at line 397 of file STK_Option.cpp.

{
  deleteValue();
  p_lReal_ = new std::list<Real>(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_lReal_.

◆ set() [7/8]

void STK::Option::set ( std::list< String > const & value )

protected

set a value from a list of String.

Parameters

value the list of string values to set

Definition at line 387 of file STK_Option.cpp.

{
  deleteValue();
  p_lString_ = new std::list<String>(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_lString_.

◆ set() [8/8]

void STK::Option::set ( String const & value )

protected

set a value from string.

Parameters

value the string value to set

Definition at line 347 of file STK_Option.cpp.

{
  deleteValue();
  p_String_ = new String(value);
  isValued_ = true;
}

References deleteValue(), isValued_, and p_String_.

Referenced by operator=(), Option(), and setValue().

◆ setDefaultValue()

void STK::Option::setDefaultValue ( )

private

set a default value of the option.

This method is used only once when the object is created.

Definition at line 472 of file STK_Option.cpp.

{
  //deleteValue();
  switch (type_)
  {
    case string_:
      p_String_ = new String;
      *p_String_ = stringNa;
      break;
    case real_:
      p_Real_ = new Real;
      *p_Real_ = Arithmetic<Real>::NA();
      break;
    case integer_:
      p_int_ = new int;
      *p_int_ = Arithmetic<int>::NA();
      break;
    case range_:
      p_Range_ = new Range;
      break;
    case lstring_:
      p_lString_ = new std::list<String>;
      break;
    case lreal_:
      p_lReal_ = new std::list<Real>;
      break;
    case linteger_:
      p_lint_ = new std::list<int>;
      break;
    case lrange_:
      p_lRange_ = new std::list<Range>;
      break;
    case page_:
      p_Page_ = 0;
      break;
    default:
      break;
  };
}

References integer_, linteger_, lrange_, lreal_, lstring_, STK::Arithmetic< Type >::NA(), p_int_, p_lint_, p_lRange_, p_lReal_, p_lString_, p_Page_, p_Range_, p_Real_, p_String_, page_, range_, real_, string_, STK::stringNa, and type_.

Referenced by Option().

◆ setListSeparator()

void STK::Option::setListSeparator ( Char const & sep )

inline

set the separator to use in the list of options.

Parameters

sep	the separator to use

Definition at line 129 of file STK_Option.h.

130 { sep_ = sep;}

References sep_.

◆ setPage()

void STK::Option::setPage ( IPage const & value )

set a value from a Page.

The field type_ of the class is set to DManager::page_.

Parameters

value the Page to set

Definition at line 263 of file STK_Option.cpp.

{
  deleteValue();
  p_Page_ = value.clone();
  isValued_ = true;
  type_ = page_;
}

References STK::IPage::clone(), deleteValue(), isValued_, p_Page_, page_, and type_.

Referenced by operator=(), and Option().

◆ setValue()

bool STK::Option::setValue ( String const & str )

Convert a string in a value.

The conversion is done using the field type_ of the class.

Parameters

str	the string to convert

Returns: true if the conversion success, false otherwise

Definition at line 192 of file STK_Option.cpp.

{
  // choose type
  switch (type_)
  {
    case string_:
      set(str);
      break;
    case real_:
    {
      Real realValue;
      if (stringToType(realValue, str)) { set(realValue);}
      else STKRUNTIME_ERROR_1ARG(Option::setValue,str,Real convertion failed.);
    }
    break;
    case integer_:
    {
      int integerValue;
      if (stringToType(integerValue, str)) { set(integerValue);}
      else STKRUNTIME_ERROR_1ARG(Option::setValue,str,Integer convertion failed.);
    }
    break;
    case range_:
    {
      Range rangeValue;
      if (stringToType(rangeValue, str)) { set(rangeValue);}
      else STKRUNTIME_ERROR_1ARG(Option::setValue,str,Range convertion failed.);
    }
    break;
    case lstring_:
    {
      std::list<String> lStringValue;
      DManager::readList(str, lStringValue);
      set(lStringValue);
    }
    break;
    case lreal_:
    {
      std::list<Real> lRealValue;
      DManager::readList(str, lRealValue);
      set(lRealValue);
    }
    break;
    case linteger_:
    {
      std::list<int> lintValue;
      DManager::readList(str, lintValue);
      set(lintValue);
    }
    break;
    case lrange_:
    {
      std::list<Range> lRangeValue;
      DManager::readList(str, lRangeValue);
      set(lRangeValue);
    }
    break;
    case page_:
      STKRUNTIME_ERROR_1ARG(Option::setValue,str,page option not allowed.);
      break;
    case unknown_:
      STKRUNTIME_ERROR_1ARG(Option::setValue,str, unknown option.);
      break; // avoid warning
  };
  // error if an error occur in readList ?
  return true;
}

References integer_, linteger_, lrange_, lreal_, lstring_, page_, range_, STK::DManager::readList(), real_, set(), setValue(), STKRUNTIME_ERROR_1ARG, string_, STK::stringToType(), type_, and unknown_.

Referenced by setValue().

◆ type()

TypeOption STK::Option::type ( ) const

inline

type of the option.

Returns: the type of the option

Definition at line 120 of file STK_Option.h.

120{ return type_;}

References type_.

Referenced by operator=(), and Option().

◆ write()

void STK::Option::write ( ostream & os ) const

write out the options in the output stream

Parameters

os	output stream

Definition at line 275 of file STK_Option.cpp.

{
  // write option name if it's not a page
  if (type_ != page_)
  {  // write name and " = "
    os << name_ << _T(" ") << CHAR_EQUAL << _T(" ");
  }
  // write option value
  switch (type_)
  {
    case string_:
      if (p_String_)
        os << *p_String_;
      break;
    case real_:
      if (p_Real_)
        os << *p_Real_;
      break;
    case integer_:
      if (p_int_)
        os << *p_int_;
      break;
    case range_:
      if (p_Range_)
        os << *p_Range_;
      break;
    case lstring_:
      if (p_lString_)
        DManager::writeList(os, *p_lString_, sep_);
      break;
    case lreal_:
      if (p_lReal_)
      DManager::writeList(os, *p_lReal_, sep_);
      break;
    case linteger_:
      if (p_lint_)
        DManager::writeList(os, *p_lint_, sep_);
      break;
    case lrange_:
      if (p_lRange_)
        DManager::writeList(os, *p_lRange_, sep_);
      break;
    case page_:
      if (p_Page_)
        p_Page_->write(os);
      break;
    case unknown_:
      STKRUNTIME_ERROR_NO_ARG(Option::write,Unknown option.);
      break; // avoid warning
  };
}

References _T, integer_, linteger_, lrange_, lreal_, lstring_, name_, p_int_, p_lint_, p_lRange_, p_lReal_, p_lString_, p_Page_, p_Range_, p_Real_, p_String_, page_, range_, real_, sep_, STKRUNTIME_ERROR_NO_ARG, string_, type_, unknown_, STK::IPage::write(), write(), and STK::DManager::writeList().

Referenced by write().

Member Data Documentation

◆ [union]

union { ... } STK::Option

value of the option.

An other choice would be void*.

◆ isOptional_

bool STK::Option::isOptional_

private

true if the option is optional, false otherwise

Definition at line 245 of file STK_Option.h.

Referenced by isOptional(), and operator=().

◆ isValued_

bool STK::Option::isValued_

private

true if the option is valued, false otherwise.

A default value is settled when the Option is created as the type is fixed.

Definition at line 248 of file STK_Option.h.

Referenced by deleteValue(), operator=(), set(), set(), set(), set(), set(), set(), set(), set(), and setPage().

◆ name_

String STK::Option::name_

private

name of the option

Definition at line 239 of file STK_Option.h.

Referenced by name(), operator=(), Option(), Option(), and write().

◆ p_int_

int* STK::Option::p_int_

Definition at line 254 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_lint_

std::list<int>* STK::Option::p_lint_

Definition at line 258 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_lRange_

std::list<Range>* STK::Option::p_lRange_

Definition at line 259 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_lReal_

std::list<Real>* STK::Option::p_lReal_

Definition at line 257 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_lString_

std::list<String>* STK::Option::p_lString_

Definition at line 256 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_Page_

IPage* STK::Option::p_Page_

Definition at line 260 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), read(), setDefaultValue(), setPage(), and write().

◆ p_Range_

Range* STK::Option::p_Range_

Definition at line 255 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_Real_

Real* STK::Option::p_Real_

Definition at line 253 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ p_String_

String* STK::Option::p_String_

Definition at line 252 of file STK_Option.h.

Referenced by deleteValue(), get(), operator=(), Option(), set(), setDefaultValue(), and write().

◆ sep_

Char STK::Option::sep_

private

Char used for the option list.

Definition at line 241 of file STK_Option.h.

Referenced by operator=(), setListSeparator(), and write().

◆ type_

TypeOption STK::Option::type_

private

type of the option

Definition at line 243 of file STK_Option.h.

Referenced by deleteValue(), operator=(), Option(), read(), setDefaultValue(), setPage(), setValue(), type(), and write().

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Option() [1/3]

◆ Option() [2/3]

◆ Option() [3/3]

◆ ~Option()

Member Function Documentation

◆ deleteValue()

◆ get() [1/9]

◆ get() [2/9]

◆ get() [3/9]

◆ get() [4/9]

◆ get() [5/9]

◆ get() [6/9]

◆ get() [7/9]

◆ get() [8/9]

◆ get() [9/9]

◆ isOptional()

◆ name()

◆ operator=()

◆ read()

◆ set() [1/8]

◆ set() [2/8]

◆ set() [3/8]

◆ set() [4/8]

◆ set() [5/8]

◆ set() [6/8]

◆ set() [7/8]

◆ set() [8/8]

◆ setDefaultValue()

◆ setListSeparator()

◆ setPage()

◆ setValue()

◆ type()

◆ write()

Member Data Documentation

◆ [union]

◆ isOptional_

◆ isValued_

◆ name_

◆ p_int_

◆ p_lint_

◆ p_lRange_

◆ p_lReal_

◆ p_lString_

◆ p_Page_

◆ p_Range_

◆ p_Real_

◆ p_String_

◆ sep_

◆ type_