GlsMenuLine Class Reference

#include <gls_menu_data.h>

Inheritance diagram for GlsMenuLine:

Public Member Functions
	GlsMenuLine (const std::string &name, std::string *data)
	GlsMenuLine (const std::string &name, const std::string &initialVal="")
virtual	~GlsMenuLine ()
virtual bool	OkToWrite ()
virtual std::istream &	ReadValue (std::istream &instr)
virtual void	Attach (std::string *&data)
virtual bool	ReferTo (std::string &data)
virtual bool	ValueChanged ()
virtual void	ResetValueChanged ()
virtual std::ostream &	WriteValue (std::ostream &outstr)
void	SetPrecision (int outputPrecision)
virtual const std::string &	Value () const
virtual std::string &	Value ()
virtual void	Value (const std::string &val)
virtual void	Inc (long amount=1)

Protected Attributes
std::string *	_data
	Storage for the meta-data. More...
std::string	_prevValue
	The previous meta-data value. More...
bool	_prevValueValid
	Whether or not the previous value should be considered. More...
int	_precision
	Allows for setting of precision for floating point numbers. More...

Detailed Description

The GlsMenuLine class is a string meta-data type that when read from a stream, will consume from current point to the end of line. This differs from a string in that the string will only consume until whitespace is found.

Definition at line 300 of file gls_menu_data.h.

Constructor & Destructor Documentation

GlsMenuLine::GlsMenuLine	(	const std::string &	name,
		std::string *	data
	)

Class constructor. Keeps a pointer to the specified type in sync with the simulation meta-data. This will set localStorage to false.

GlsMenuLine::GlsMenuLine	(	const std::string &	name,
		const std::string &	initialVal = ""
	)

Class constructor. Actually creates storage for the simulation meta-data and initializes the value. This will set localStorage to true.

virtual GlsMenuLine::~GlsMenuLine ( )

virtual

Class destructor.

Member Function Documentation

virtual void GlsMenuData_T< std::string >::Attach ( std::string *&  data )

virtualinherited

Attaches an external pointer to the data so that dereferencing the pointer will allow access to the data item's value without performing dictionary lookups and data value retrievals.

virtual void GlsMenuData::Inc ( long  amount = 1 )

virtualinherited

Increment the data item. Derived classes must override this as the default is a no-op.

Reimplemented in GlsMenuDiscrete_T< T >.

Referenced by GlsMenuSet_T< MenuType_t, DataFactory_t >::IncData().

virtual bool GlsMenuLine::OkToWrite ( )

virtual

Returns false if the string is empty.

virtual std::istream& GlsMenuLine::ReadValue ( std::istream &  instr )

virtual

Read the stream until an end of line is encountered.

Reimplemented from GlsMenuData_T< std::string >.

Reimplemented in GlsMenuActionGroup.

virtual bool GlsMenuData_T< std::string >::ReferTo ( std::string &  data )

virtualinherited

Changes the data item to refer to and use the external variable rather than its own memory. Allows access to the data item's value without performing dictionary lookups and data value retrievals.

virtual void GlsMenuData_T< std::string >::ResetValueChanged ( )

virtualinherited

Sets the previous value to the current value.

void GlsMenuData_T< std::string >::SetPrecision ( int  outputPrecision )

inherited

Allows for setting of precision for floating point numbers. This is the number of digits to be shown after the decimal point.

virtual const std::string & GlsMenuData_T< std::string >::Value ( ) const

virtualinherited

Returns the value of the simulation meta-data.

virtual std::string & GlsMenuData_T< std::string >::Value ( )

virtualinherited

Returns a reference value of the simulation meta-data.

virtual void GlsMenuData_T< std::string >::Value ( const std::string &  val )

virtualinherited

Sets the value of the simulation meta-data.

virtual bool GlsMenuData_T< std::string >::ValueChanged ( )

virtualinherited

Determines if the value has changed since the last call to this method.

virtual std::ostream& GlsMenuData_T< std::string >::WriteValue ( std::ostream &  outstr )

virtualinherited

Writes the value to the output stream.

Reimplemented in GlsMenuActionGroup.

Field Documentation

std::string * GlsMenuData_T< std::string >::_data

protectedinherited

Storage for the meta-data.

Definition at line 220 of file gls_menu_data.h.

int GlsMenuData_T< std::string >::_precision

protectedinherited

Allows for setting of precision for floating point numbers.

Definition at line 229 of file gls_menu_data.h.

std::string GlsMenuData_T< std::string >::_prevValue

protectedinherited

The previous meta-data value.

Definition at line 223 of file gls_menu_data.h.

bool GlsMenuData_T< std::string >::_prevValueValid

protectedinherited

Whether or not the previous value should be considered.

Definition at line 226 of file gls_menu_data.h.

---

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

• gls_menu_data.h