String Class Reference

Dakota::String class, used as main string class for Dakota. More...

List of all members.

Public Member Functions
	String ()
	Default constructor.
	String (const String &a)
	Copy constructor for incoming String.
	String (const String &a, size_t start_index, size_t num_items)
	Copy constructor for portion of incoming String.
	String (const char *c_string)
	Copy constructor for incoming char* array.
	String (const DAKOTA_BASE_STRING &a)
	Copy constructor for incoming base string.
	~String ()
	Destructor.
String &	operator= (const String &)
	Assignment operator for incoming String.
String &	operator= (const DAKOTA_BASE_STRING &)
	Assignment operator for incoming base string.
String &	operator= (const char *)
	Assignment operator for incoming char* array.
	operator const char * () const
	The operator() returns pointer to standard C char array.
String &	toUpper ()
	Convert to upper case string.
void	upper ()
String &	toLower ()
	Convert to lower case string.
void	lower ()
bool	contains (const char *sub_string) const
	Returns true if String contains char* substring.
bool	begins (const char *sub_string) const
	Returns true if String starts with char* substring.
bool	ends (const char *sub_string) const
	Returns true if String ends with char* substring.
char *	data () const
	Returns pointer to standard C char array.

---

Detailed Description

Dakota::String class, used as main string class for Dakota.

The Dakota::String class is the common string class for Dakota. It provides a common interface for string operations whether inheriting from the STL basic_string or the Rogue Wave RWCString class

---

Member Function Documentation

operator const char *

(

)

const [inline]

The operator() returns pointer to standard C char array.

The operator () returns a pointer to a char string. Uses the STL c_str() method. This allows for the String to be used in method calls without having to call the data() or c_str() methods.

void upper

(

)

Private method which converts String to upper. Utilizes an STL iterator to step through the string and then calls the STL toupper() method. Needs to be done this way because STL only provides a single char toupper method.

void lower

(

)

Private method which converts String to lower. Utilizes an STL iterator to step through the string and then calls the STL tolower() method. Needs to be done this way because STL only provides a single char tolower method.

bool contains

(

const char *

sub_string

)

const [inline]

Returns true if String contains char* substring.

Returns true if the String contains the char* sub_string. Uses the STL find() method.

bool begins

(

const char *

sub_string

)

const [inline]

Returns true if String starts with char* substring.

Returns true if the String begins with the char* sub_string. Uses the STL compare() method.

bool ends

(

const char *

sub_string

)

const [inline]

Returns true if String ends with char* substring.

Returns true if the String ends with the char* sub_string. Uses the STL compare() method.

char * data

(

)

const [inline]

Returns pointer to standard C char array.

Returns a pointer to C style char array. Needed to mimic the Rogue Wave string class. USE WITH CARE.

---

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

• DakotaString.H
• DakotaString.C

---