String Class Reference

string variable More...

#include <String.h>

Inheritance diagram for String:

Public Member Functions

 String (const std::string &tag, const std::string &description, const std::string &value, Persistent *parent=nullptr)
 main constructor More...
 
Stringoperator= (const std::string &rhs)
 assign from string More...
 
 String (String &&other)
 move constructor More...
 
Stringoperator= (String &&other)
 move assignment; we use a little trick with the return type More...
 
const std::string & type () const override
 
- Public Member Functions inherited from Type< std::string >
 Type (const std::string &tag, const std::string &description, Persistent *parent, const std::string &value)
 main constructor More...
 
 Type (Type &&other)
 move constructor More...
 
Typeoperator= (Type &&other)
 move assignment More...
 
std::string & value (void)
 Type value getter. More...
 
const std::string & value (void) const
 
bool operator!= (const Type &rhs) const
 
bool operator== (const Type &rhs) const
 
- Public Member Functions inherited from Item
 Item (const Item &other)
 copy constructor copies all elements but parent which is set to nullptr More...
 
Itemoperator= (const Item &other)
 copy assignment operator copies all elements but parent which is set to nullptr More...
 
 Item (const std::string &tag, const std::string &description, Persistent *parent)
 
 Item (Item &&other)
 move constructor More...
 
Itemoperator= (Item &&other)
 move assignment operator More...
 
virtual ~Item ()
 
const std::string & tag () const
 
const std::string & description () const
 
std::string fullTag () const
 
const Persistentparent () const
 
virtual const std::string & type () const =0
 
void setTag (const std::string &tag)
 
void setDescription (const std::string &description)
 
void setWideTag (const std::wstring &tag)
 wide-character variant, More...
 
void setWideDescription (const std::wstring &description)
 wide-character variant, More...
 
bool operator!= (const Item &rhs) const
 
bool operator== (const Item &rhs) const
 

Additional Inherited Members

- Public Types inherited from Type< std::string >
typedef std::string ValueType
 name the value type to make it possible for function templates acting on Type<T> to access T properties and methods More...
 
- Protected Attributes inherited from Type< std::string >
std::string value_
 
- Protected Attributes inherited from Item
Persistentparent_
 pointer to the parent Persistent; set to this by the constructor if Item is self-standing or a root Persistent of a tree More...
 

Detailed Description

string variable

used for configuration parameters (option), error messages (errorMsg)

#include <libpf/persistency/String.h>

Remarks
Warning
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ String() [1/2]

String::String ( const std::string &  tag,
const std::string &  description,
const std::string &  value,
Persistent parent = nullptr 
)
inline

main constructor

◆ String() [2/2]

String::String ( String &&  other)
inline

move constructor

Member Function Documentation

◆ operator=() [1/2]

String & String::operator= ( const std::string &  rhs)

assign from string

◆ operator=() [2/2]

String & String::operator= ( String &&  other)
inline

move assignment; we use a little trick with the return type

◆ type()

const std::string & String::type ( ) const
overridevirtual
Returns
the C++ name of the class the instance belongs to
Note
it is the responsibility of the caller to not access this reference after the lifecycle of the Item

Implements Item.


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