Detailed Description

Wrapper for a std::string, for formatted ostream output.

An Str object has std::string value, and an integer output field width. The << operator for an Str object uses the specified width. The value and width may both be specified as parameters to a constructor. If the width is not specified as a constructor parameter, it is set within the constructor to a default value given by Format::defaultWidth().

An Str object may be passed to an ostream as a temporary object. For example, the expression:

std::cout << Str("Hello") << Str("World", 20) << std::endl;

outputs "Hello" using the default width, followed by "World" in a field of width 20.

Definition at line 36 of file Str.h.

#include <Str.h>

Public Member Functions
Constructors
	Str ()
	Default constructor. More...

	Str (std::string value)
	Constructor, value only. More...

	Str (std::string value, int width)
	Constructor, value and width. More...

Mutators
void	setValue (std::string value)

void	setWidth (int width)

Accessors
std::string	value () const

int	width () const

Friends
std::istream &	operator>> (std::istream &in, Str &object)
	Input stream extractor for an Str object. More...

std::ostream &	operator<< (std::ostream &out, const Str &object)
	Output stream inserter for an Str object. More...

Constructor & Destructor Documentation

Util::Str::Str ( )

Default constructor.

Definition at line 17 of file Str.cpp.

Util::Str::Str ( std::string value )

explicit

Constructor, value only.

Constructor, value only (explicit).

Definition at line 23 of file Str.cpp.

Util::Str::Str	(	std::string	value,
		int	width
	)

Constructor, value and width.

Definition at line 29 of file Str.cpp.

Friends And Related Function Documentation

std::istream& operator>>	(	std::istream &	in,
		Str &	object
	)

friend

Input stream extractor for an Str object.

Parameters

in	input stream
object	Str object to be read from stream

Returns: modified input stream

Definition at line 49 of file Str.cpp.

std::ostream& operator<<	(	std::ostream &	out,
		const Str &	object
	)

friend

Output stream inserter for an Str object.

Parameters

out	output stream
object	Str to be written to stream

Returns: modified output stream

Definition at line 58 of file Str.cpp.

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

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Friends And Related Function Documentation