Public Member Functions
ConfigVariableString Class Reference

This is a convenience class to specialize ConfigVariable as a string type. More...

#include "configVariableString.h"

Inheritance diagram for ConfigVariableString:
ConfigVariable ConfigVariableBase ConfigFlags

List of all members.

Public Member Functions

 ConfigVariableString (const string &name)
 ConfigVariableString (const string &name, const string &default_value, const string &description=string(), int flags=0)
const char * c_str () const
bool empty () const
string get_default_value () const
 Returns the variable's default value.
const string & get_value () const
 Returns the variable's value.
string get_word (int n) const
 Returns the variable's nth value.
size_t length () const
 operator const string & () const
 Returns the variable's value.
bool operator!= (const string &other) const
bool operator< (const string &other) const
void operator= (const string &value)
 Reassigns the variable's local value.
bool operator== (const string &other) const
char operator[] (int n) const
void set_value (const string &value)
 Reassigns the variable's local value.
void set_word (int n, const string &value)
 Reassigns the variable's nth value.

Detailed Description

This is a convenience class to specialize ConfigVariable as a string type.

Definition at line 26 of file configVariableString.h.

Member Function Documentation

string ConfigVariableString::get_default_value ( ) const [inline]

Returns the variable's default value.

Reimplemented from ConfigVariable.

Definition at line 170 of file configVariableString.I.

References ConfigDeclaration::get_string_value().

const string & ConfigVariableString::get_value ( ) const [inline]

Returns the variable's value.

Definition at line 155 of file configVariableString.I.

References ConfigVariable::get_string_value(), ConfigFlags::is_cache_valid(), and ConfigFlags::mark_cache_valid().

Referenced by operator const string &().

string ConfigVariableString::get_word ( int  n) const [inline]

Returns the variable's nth value.

Definition at line 184 of file configVariableString.I.

References ConfigVariable::get_string_word().

Referenced by GraphicsOutput::GraphicsOutput().

ConfigVariableString::operator const string & ( ) const [inline]

Returns the variable's value.

Definition at line 64 of file configVariableString.I.

References get_value().

void ConfigVariableString::operator= ( const string &  value) [inline]

Reassigns the variable's local value.

Definition at line 54 of file configVariableString.I.

References set_value().

void ConfigVariableString::set_value ( const string &  value) [inline]

Reassigns the variable's local value.

Definition at line 145 of file configVariableString.I.

References ConfigVariable::set_string_value().

Referenced by operator=().

void ConfigVariableString::set_word ( int  n,
const string &  value 
) [inline]

Reassigns the variable's nth value.

This makes a local copy of the variable's overall value.

Definition at line 195 of file configVariableString.I.

References ConfigVariable::set_string_word().

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