MPQC  3.0.0-alpha
sc::KeyValValuestring Class Reference

Represents a std::string value. More...

#include <util/keyval/keyvalval.h>

Inheritance diagram for sc::KeyValValuestring:
sc::KeyValValue sc::RefCount

Public Member Functions

 KeyValValuestring (const std::string &)
 
 KeyValValuestring (const KeyValValuestring &)
 
KeyValValue::KeyValValueError doublevalue (double &) const
 Converts the string to double.
 
KeyValValue::KeyValValueError booleanvalue (int &) const
 Converts the string to boolean. More...
 
KeyValValue::KeyValValueError floatvalue (float &) const
 Converts the string to float.
 
KeyValValue::KeyValValueError charvalue (char &) const
 Converts the string to char.
 
KeyValValue::KeyValValueError intvalue (int &) const
 Converts the string to int.
 
KeyValValue::KeyValValueError longvalue (long &) const
 Converts the string to long.
 
KeyValValue::KeyValValueError sizevalue (size_t &) const
 Converts the string to size_t. More...
 
DEPRECATED KeyValValue::KeyValValueError pcharvalue (const char *&) const
 Converts the string to a pointer to char (deprecated).
 
KeyValValue::KeyValValueError stringvalue (std::string &) const
 
void print (std::ostream &o=ExEnv::out0()) const
 
- Public Member Functions inherited from sc::KeyValValue
 KeyValValue (const KeyValValue &)
 
virtual KeyValValue::KeyValValueError describedclassvalue (Ref< DescribedClass > &) const
 
- Public Member Functions inherited from sc::RefCount
size_t identifier () const
 Return the unique identifier for this object that can be compared for different objects of different types. More...
 
int lock_ptr () const
 Lock this object.
 
int unlock_ptr () const
 Unlock this object.
 
void use_locks (bool inVal)
 start and stop using locks on this object
 
refcount_t nreference () const
 Return the reference count.
 
refcount_t reference ()
 Increment the reference count and return the new count.
 
refcount_t dereference ()
 Decrement the reference count and return the new count.
 
int managed () const
 
void unmanage ()
 Turn off the reference counting mechanism for this object. More...
 

Additional Inherited Members

- Public Types inherited from sc::KeyValValue
enum  KeyValValueError { OK, WrongType }
 
- Protected Member Functions inherited from sc::RefCount
 RefCount (const RefCount &)
 
RefCountoperator= (const RefCount &)
 

Detailed Description

Represents a std::string value.

This can convert the string to a variety of other types.

Member Function Documentation

◆ booleanvalue()

KeyValValue::KeyValValueError sc::KeyValValuestring::booleanvalue ( int &  ) const
virtual

Converts the string to boolean.

True can be given as 1, true, or yes. False can be given as 0, false, or no.

Reimplemented from sc::KeyValValue.

◆ sizevalue()

KeyValValue::KeyValValueError sc::KeyValValuestring::sizevalue ( size_t &  ) const
virtual

Converts the string to size_t.

Various suffices are recognized: kB, KB, MB, GB, kiB, KIB, MIB, and GIB.

Reimplemented from sc::KeyValValue.


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

Generated at Sun Jan 26 2020 23:24:06 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.8.16.