Util::OptionalLabel Class Reference

An optional Label string in a file format. More...

#include <OptionalLabel.h>

Inheritance diagram for Util::OptionalLabel:

Public Member Functions
	OptionalLabel ()
	Default constructor.
	OptionalLabel (std::string string)
	Constructor.
	OptionalLabel (const char *string)
	Constructor.
	OptionalLabel (const OptionalLabel &other)
	Copy constructor.
virtual	~OptionalLabel ()
	Destructor.
Public Member Functions inherited from Util::Label
	Label (bool isRequired=true)
	Constructor.
	Label (std::string string, bool isRequired=true)
	Constructor.
	Label (const char *string, bool isRequired=true)
	Constructor.
	Label (const Label &other)
	Copy constructor.
virtual	~Label ()
	Destructor.
void	setString (std::string string)
	Set the label string.
void	setIsRequired (bool isRequired)
	Set the isRequired boolean flag.
bool	match (std::istream &in)
	Read and attempt to match next word in an input stream.
std::string	string () const
	Return label string.
bool	isRequired () const
	Is this the label for a required component?

Additional Inherited Members
Static Public Member Functions inherited from Util::Label
static void	read (std::istream &in)
	Read a string without checking its value.
static void	clear ()
	Clear the input buffer.
static void	setIsMatched (bool isMatched)
	Explicitly set the isMatched flag.
static std::string	buffer ()
	Get the string that is currently in the input buffer.
static bool	isClear ()
	Is the input buffer clear?
static bool	isMatched ()
	Did the most recent attempt to match a Label succeed?
Static Public Attributes inherited from Util::Label
static const int	LabelWidth = 20
	Width of label field in file output format.

Detailed Description

An optional Label string in a file format.

A subclass of Label that is always optional.

Definition at line 23 of file OptionalLabel.h.

Constructor & Destructor Documentation

OptionalLabel() [1/4]

Util::OptionalLabel::OptionalLabel

(

)

Default constructor.

Definition at line 16 of file OptionalLabel.cpp.

References Util::Label::Label().

Referenced by OptionalLabel().

OptionalLabel() [2/4]

Util::OptionalLabel::OptionalLabel ( std::string string )

explicit

Constructor.

Parameters

string

label string that precedes value in file format

Definition at line 23 of file OptionalLabel.cpp.

References Util::Label::Label(), and Util::Label::string().

OptionalLabel() [3/4]

Util::OptionalLabel::OptionalLabel ( const char * string )

explicit

Constructor.

Parameters

string

label string that precedes value in file format

Definition at line 30 of file OptionalLabel.cpp.

References Util::Label::Label(), and Util::Label::string().

OptionalLabel() [4/4]

Util::OptionalLabel::OptionalLabel

(

const OptionalLabel &

other

)

Copy constructor.

Parameters

other

OptionalLabel being cloned.

Definition at line 37 of file OptionalLabel.cpp.

References Util::Label::Label(), OptionalLabel(), and Util::Label::string().

~OptionalLabel()

Util::OptionalLabel::~OptionalLabel ( )

virtual

Destructor.

Definition at line 44 of file OptionalLabel.cpp.

---

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

• OptionalLabel.h
• OptionalLabel.cpp