Panda3D
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
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

Public Member Functions

 ConfigVariableString (const std::string &name)
 
 ConfigVariableString (const std::string &name, const std::string &default_value, const std::string &description=std::string(), int flags=0)
 
const char * c_str () const
 
bool empty () const
 
std::string get_default_value () const
 
const std::string & get_value () const
 
std::string get_word (size_t n) const
 Returns the variable's nth value.
 
size_t length () const
 
 operator const std::string & () const
 Returns the variable's value.
 
bool operator!= (const std::string &other) const
 
bool operator< (const std::string &other) const
 
void operator= (const std::string &value)
 Reassigns the variable's local value.
 
bool operator== (const std::string &other) const
 
char operator[] (size_t n) const
 
void set_value (const std::string &value)
 
void set_word (size_t n, const std::string &value)
 Reassigns the variable's nth value.
 
- Public Member Functions inherited from ConfigVariable
 ConfigVariable (const std::string &name)
 Use this constructor to make a ConfigVariable of an unspecified type.
 
void clear_value ()
 Removes the value assigned to this variable, and lets its original value (as read from the prc files) show through.
 
size_t get_num_words () const
 Returns the number of words in the variable's value.
 
const std::string & get_string_value () const
 Returns the toplevel value of the variable, formatted as a string.
 
void set_string_value (const std::string &value)
 Changes the value assigned to this variable.
 
- Public Member Functions inherited from ConfigVariableBase
bool clear_local_value ()
 Removes the local value defined for this variable, and allows its value to be once again retrieved from the .prc files.
 
const std::string & get_description () const
 
int get_flags () const
 Returns the flags value as set by set_flags().
 
const std::string & get_name () const
 
int get_trust_level () const
 
ValueType get_value_type () const
 
bool has_local_value () const
 Returns true if this variable's value has been shadowed by a local assignment (as created via make_local_value()), or false otherwise.
 
bool has_value () const
 Returns true if this variable has an explicit value, either from a prc file or locally set, or false if variable has its default value.
 
bool is_closed () const
 
bool is_dynamic () const
 
void output (std::ostream &out) const
 
void write (std::ostream &out) const
 

Public Attributes

 get_default_value
 Returns the variable's default value.
 
 get_value
 Returns the variable's value.
 
 set_value
 Reassigns the variable's local value.
 
- Public Attributes inherited from ConfigVariableBase
 get_description
 Returns the brief description of this variable, if it has been defined.
 
 get_name
 Returns the name of the variable.
 
 get_trust_level
 Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable.
 
 get_value_type
 Returns the stated type of this variable.
 
 is_closed
 Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()).
 
 is_dynamic
 Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables.
 

Additional Inherited Members

- Public Types inherited from ConfigFlags
enum  ValueType {
  VT_undefined , VT_list , VT_string , VT_filename ,
  VT_bool , VT_int , VT_double , VT_enum ,
  VT_search_path , VT_int64 , VT_color
}
 
enum  VariableFlags {
  F_trust_level_mask = 0x00000fff , F_open = 0x00001000 , F_closed = 0x00002000 , F_dynamic = 0x00004000 ,
  F_dconfig = 0x00008000
}
 

Detailed Description

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

Definition at line 23 of file configVariableString.h.

Constructor & Destructor Documentation

◆ ConfigVariableString() [1/2]

ConfigVariableString::ConfigVariableString ( const std::string & name)
inline

Definition at line 17 of file configVariableString.I.

◆ ConfigVariableString() [2/2]

ConfigVariableString::ConfigVariableString ( const std::string & name,
const std::string & default_value,
const std::string & description = std::string(),
int flags = 0 )
inline

Definition at line 28 of file configVariableString.I.

Member Function Documentation

◆ c_str()

const char * ConfigVariableString::c_str ( ) const
inline

Definition at line 61 of file configVariableString.I.

◆ empty()

bool ConfigVariableString::empty ( ) const
inline

Definition at line 69 of file configVariableString.I.

◆ get_word()

std::string ConfigVariableString::get_word ( size_t n) const
inline

Returns the variable's nth value.

Definition at line 150 of file configVariableString.I.

Referenced by LoaderFileTypeAssimp::get_additional_extensions().

◆ length()

size_t ConfigVariableString::length ( ) const
inline

Definition at line 77 of file configVariableString.I.

◆ operator const std::string &()

ConfigVariableString::operator const std::string & ( ) const
inline

Returns the variable's value.

Definition at line 53 of file configVariableString.I.

◆ operator!=()

bool ConfigVariableString::operator!= ( const std::string & other) const
inline

Definition at line 102 of file configVariableString.I.

◆ operator<()

bool ConfigVariableString::operator< ( const std::string & other) const
inline

Definition at line 110 of file configVariableString.I.

◆ operator=()

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

Reassigns the variable's local value.

Definition at line 45 of file configVariableString.I.

References set_value.

◆ operator==()

bool ConfigVariableString::operator== ( const std::string & other) const
inline

Definition at line 94 of file configVariableString.I.

◆ operator[]()

char ConfigVariableString::operator[] ( size_t n) const
inline

Definition at line 85 of file configVariableString.I.

◆ set_word()

void ConfigVariableString::set_word ( size_t n,
const std::string & value )
inline

Reassigns the variable's nth value.

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

Definition at line 159 of file configVariableString.I.

Member Data Documentation

◆ get_default_value

std::string ConfigVariableString::get_default_value
inline

Returns the variable's default value.

Definition at line 47 of file configVariableString.h.

◆ get_value

const std::string & ConfigVariableString::get_value
inline

Returns the variable's value.

Definition at line 46 of file configVariableString.h.

◆ set_value

void ConfigVariableString::set_value
inline

Reassigns the variable's local value.

Definition at line 46 of file configVariableString.h.

Referenced by operator=().


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