GETPOT_NAMESPACE::GetPot::variable Struct Reference

Variable to be specified on the command line or in input files. More...

Public Member Functions
	variable ()
	constructors, destructors, assignment operator
	variable (const variable &)
	variable (const char *Name, const char *Value, const char *FieldSeparator)
	~variable ()
variable &	operator= (const variable &Other)
void	take (const char *Value, const char *FieldSeparator)
const std::string *	get_element (unsigned Idx) const
	get a specific element in the string vector (return 0 if not present)

Public Attributes
std::string	name
	data members
STRING_VECTOR	value
std::string	original

Detailed Description

Variable to be specified on the command line or in input files.

(i.e. of the form var='12 312 341')

Definition at line 480 of file getpot.h.

Constructor & Destructor Documentation

variable() [1/3]

GETPOT_NAMESPACE::GetPot::variable::variable ( )

inline

constructors, destructors, assignment operator

Definition at line 3907 of file getpot.h.

  : name(),
    value(),
    original()
{}

variable() [2/3]

GETPOT_NAMESPACE::GetPot::variable::variable ( const variable &  Other )

inline

Definition at line 3916 of file getpot.h.

{
#ifdef WIN32
  operator=(Other);
#else
  GetPot::variable::operator=(Other);
#endif
}

References GETPOT_NAMESPACE::GetPot::operator=(), and operator=().

variable() [3/3]

GETPOT_NAMESPACE::GetPot::variable::variable ( const char *  Name, const char *  Value, const char *  FieldSeparator  )

inline

Definition at line 3928 of file getpot.h.

  : name(Name)
{
  // make a copy of the 'Value'
  take(Value, FieldSeparator);
}

References take().

~variable()

GETPOT_NAMESPACE::GetPot::variable::~variable ( )

inline

Definition at line 4003 of file getpot.h.

{}

Member Function Documentation

get_element()

const std::string * GETPOT_NAMESPACE::GetPot::variable::get_element ( unsigned  Idx ) const

inline

get a specific element in the string vector (return 0 if not present)

Definition at line 3938 of file getpot.h.

{
  if (Idx >= value.size())
    return 0;
  else
    return &(value[Idx]);
}

References value.

Referenced by GETPOT_NAMESPACE::GetPot::_DBE_expand(), GETPOT_NAMESPACE::GetPot::get_value_no_default(), and GETPOT_NAMESPACE::GetPot::operator()().

operator=()

GetPot::variable & GETPOT_NAMESPACE::GetPot::variable::operator= ( const variable &  Other )

inline

Definition at line 4009 of file getpot.h.

{
  if (&Other != this)
    {
      name     = Other.name;
      value    = Other.value;
      original = Other.original;
    }
  return *this;
}

References name, original, value, and value.

Referenced by variable().

take()

void GETPOT_NAMESPACE::GetPot::variable::take ( const char *  Value, const char *  FieldSeparator  )

inline

Definition at line 3949 of file getpot.h.

{
  original = std::string(Value); // string member var
  value.clear();                 // vector<string> member var
 
  /*
  // separate string by white space delimiters using 'strtok'
  // thread safe usage of strtok (no static members)
  char* spt = 0;
  // make a copy of the 'Value'
  char* copy = new char[strlen(Value)+1];
  strcpy(copy, Value);
  char* follow_token = strtok_r(copy, FieldSeparator, &spt);
  while (follow_token != 0)
  {
  value.push_back(std::string(follow_token));
  follow_token = strtok_r(NULL, FieldSeparator, &spt);
  }
 
  delete [] copy;
  */
 
  // Don't use strtok, instead tokenize the input char "Value" using std::string operations so
  // that the results end up in the local "value" member
 
  // Construct std::string objects from the input char*s.  I think the only
  // FieldSeparator recognized by GetPot is whitespace?
  std::string Value_str = std::string(Value);
  std::string delimiters = std::string(FieldSeparator);
 
  // Skip delimiters at beginning.
  std::string::size_type lastPos = Value_str.find_first_not_of(delimiters, 0);
 
  // Find first "non-delimiter".
  std::string::size_type pos     = Value_str.find_first_of(delimiters, lastPos);
 
  // Loop over the input string until all the tokens have been pushed back
  // into the local "value" member.
  while (std::string::npos != pos || std::string::npos != lastPos)
    {
      // Found a token, add it to the vector.
      value.push_back(Value_str.substr(lastPos, pos - lastPos));
 
      // Skip delimiters.  Note the "not_of"
      lastPos = Value_str.find_first_not_of(delimiters, pos);
 
      // Find next "non-delimiter"
      pos = Value_str.find_first_of(delimiters, lastPos);
    }
 
  // We're done, all the tokens should now be in the vector<string>
}

References value.

Referenced by variable().

Member Data Documentation

name

std::string GETPOT_NAMESPACE::GetPot::variable::name

data members

Definition at line 502 of file getpot.h.

Referenced by GETPOT_NAMESPACE::GetPot::_DBE_expand(), and operator=().

original

std::string GETPOT_NAMESPACE::GetPot::variable::original

Definition at line 504 of file getpot.h.

Referenced by GETPOT_NAMESPACE::GetPot::_DBE_expand(), GETPOT_NAMESPACE::GetPot::_DBE_get_variable(), GETPOT_NAMESPACE::GetPot::get_value_no_default(), GETPOT_NAMESPACE::GetPot::operator()(), and operator=().

value

STRING_VECTOR GETPOT_NAMESPACE::GetPot::variable::value

Definition at line 503 of file getpot.h.

Referenced by GETPOT_NAMESPACE::GetPot::_DBE_expand(), operator=(), and GETPOT_NAMESPACE::GetPot::vector_variable_size().

---

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

• include/base/getpot.h