AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface
Public Member Functions | List of all members
drama::gitarg::String Class Reference

Detailed Description

A class which reads a string item from an SDS structure.

This class is a subclass of std::string and hence all the normal string operations are possible. All std::string constructors are inherited. The std::string assignment operators are re-implemented.

This combination which should mean that this class could be used where-ever a std::string is used, but would provide the Get() function to get the value from an SDS structure, as well as a similar style constructor.

#include "gitarg.hh"

Inheritance diagram for drama::gitarg::String:
drama::gitarg::Filename

Public Member Functions

 String ()
 Default constructor.
 
 String (const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const std::string &Default="", const Flags flags=Flags::KeepErr)
 Constructor with the initial value set from an SDS structure.
 
 String (const String &)=default
 Copy constructor Default is sufficent.
 
 String (drama::thread::TAction *taction, const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const std::string &Default="", const Flags flags=Flags::KeepErr)
 Constructor with the initial value set from an SDS structure.
 
virtual void Get (const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const std::string &Default="", const Flags flags=Flags::KeepErr)
 Fetch the value of this item from an SDS structure.
 
Stringoperator= (char c)
 Set this gitarg::String to a string containing a single character.
 
String operator= (const char *s)
 Copy contents of a C string into this gitarg::String.
 
String operator= (const std::string &str)
 Assign a std::string to this gitarg::String.
 
String operator= (const String &str)
 Assign a const std::string to this gitarg::String.
 

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