Instance of a single line in a parameter window. More...

#include <GUIParameterTableItem.h>

Inheritance diagram for GUIParameterTableItem< T >:

Collaboration diagram for GUIParameterTableItem< T >:

Public Member Functions
bool	dynamic () const
	Returns the information whether this item may change over time. More...

ValueSource< double > *	getdoubleSourceCopy () const
	Returns a double-typed copy of the source if the value is dynamic. More...

const std::string &	getName () const
	Returns the name of this value. More...

ValueSource< T > *	getSourceCopy () const
	Returns a copy of the source if the value is dynamic. More...

	GUIParameterTableItem (FXTable *table, unsigned pos, const std::string &name, bool dynamic, T value)
	Constructor for non-changing (static) values. More...

	GUIParameterTableItem (FXTable table, unsigned pos, const std::string &name, bool dynamic, ValueSource< T > src)
	Constructor for changing (dynamic) values. More...

void	init (bool dynamic, std::string value)
	Initialises the line. More...

void	update ()
	Resets the value if it's dynamic. More...

	~GUIParameterTableItem ()
	Destructor. More...

Private Attributes
bool	myAmDynamic
	Information whether the value may change. More...

std::string	myName
	The name of this value. More...

ValueSource< T > *	mySource
	The source to gain new values from; this source is==0 if the values are not dynamic. More...

FXTable *	myTable
	The table this entry belongs to. More...

FXint	myTablePosition
	The position within the table. More...

T	myValue
	A backup of the value to avoid the redrawing when nothing has changed. More...

Detailed Description

template<class T>
class GUIParameterTableItem< T >

Instance of a single line in a parameter window.

This class represents a single item of a parameter table and is an implementation of the GUIParameterTableItemInterface that allows different value-types.

As some values may change over the simulation, this class holds the information whether they change and how to ask for new values if they do.

See also: GUIParameterTracker; GUIParameterTableItemInterface

Definition at line 96 of file GUIParameterTableItem.h.

Constructor & Destructor Documentation

◆ GUIParameterTableItem() [1/2]

template<class T >

GUIParameterTableItem< T >::GUIParameterTableItem	(	FXTable *	table,
		unsigned	pos,
		const std::string &	name,
		bool	dynamic,
		ValueSource< T > *	src
	)

inline

Constructor for changing (dynamic) values.

Parameters

[in]	table	The table this item belongs to
[in]	pos	The row of the table this item fills
[in]	name	The name of the represented value
[in]	dynamic	Information whether this value changes over time
[in]	src	The value source

Todo:

Consider using a reference to the table

Check whether the name should be stored in GUIParameterTableItemInterface

Definition at line 108 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::dynamic(), ValueSource< T >::getValue(), and GUIParameterTableItem< T >::init().

◆ GUIParameterTableItem() [2/2]

template<class T >

GUIParameterTableItem< T >::GUIParameterTableItem	(	FXTable *	table,
		unsigned	pos,
		const std::string &	name,
		bool	dynamic,
		T	value
	)

inline

Constructor for non-changing (static) values.

Parameters

[in]	table	The table this item belongs to
[in]	pos	The row of the table this item fills
[in]	name	The name of the represented value
[in]	dynamic	Information whether this value changes over time
[in]	value	The value

Todo:

Consider using a reference to the table

Check whether the name should be stored in GUIParameterTableItemInterface

Should never be dynamic!?

Definition at line 126 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::dynamic(), and GUIParameterTableItem< T >::init().

◆ ~GUIParameterTableItem()

template<class T >

GUIParameterTableItem< T >::~GUIParameterTableItem ( )

inline

Destructor.

Definition at line 134 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::mySource.

Member Function Documentation

◆ dynamic()

template<class T >

bool GUIParameterTableItem< T >::dynamic ( ) const

inlinevirtual

Returns the information whether this item may change over time.

Implements GUIParameterTableItemInterface.

Definition at line 166 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::myAmDynamic.

Referenced by GUIParameterTableItem< T >::GUIParameterTableItem(), GUIParameterTableItem< T >::init(), and GUIParameterTableItem< T >::update().

Here is the caller graph for this function:

◆ getdoubleSourceCopy()

template<class T >

ValueSource<double>* GUIParameterTableItem< T >::getdoubleSourceCopy ( ) const

inlinevirtual

Returns a double-typed copy of the source if the value is dynamic.

Implements GUIParameterTableItemInterface.

Definition at line 202 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::mySource.

Referenced by GUIParameterTableItem< T >::init().

Here is the caller graph for this function:

◆ getName()

template<class T >

const std::string& GUIParameterTableItem< T >::getName ( ) const

inlinevirtual

Returns the name of this value.

Implements GUIParameterTableItemInterface.

Definition at line 171 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::myName.

◆ getSourceCopy()

template<class T >

ValueSource<T>* GUIParameterTableItem< T >::getSourceCopy ( ) const

inline

Returns a copy of the source if the value is dynamic.

Definition at line 194 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::mySource.

◆ init()

template<class T >

void GUIParameterTableItem< T >::init	(	bool	dynamic,
		std::string	value
	)

inline

Initialises the line.

Fills the line using the name, the current value, and the information whether the value changes over time.

Parameters

[in]	dynamic	Information whether this value changes over time
[in]	value	The current (initial) value

Definition at line 146 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::dynamic(), GUIParameterTableItem< T >::getdoubleSourceCopy(), GUIIconSubSys::getIcon(), GUIParameterTableItem< T >::myName, GUIParameterTableItem< T >::myTable, GUIParameterTableItem< T >::myTablePosition, NO, TRACKER, and YES.

Referenced by GUIParameterTableItem< T >::GUIParameterTableItem().

Here is the caller graph for this function:

◆ update()

template<class T >

void GUIParameterTableItem< T >::update ( )

inlinevirtual

Resets the value if it's dynamic.

If the value is dynamic, the current value is retrieved from the value source. If it is different from the previous one (stored in myValue), it is stored in myValue and set as the current value text within the according table cell.

Implements GUIParameterTableItemInterface.

Definition at line 182 of file GUIParameterTableItem.h.

References GUIParameterTableItem< T >::dynamic(), GUIParameterTableItem< T >::mySource, GUIParameterTableItem< T >::myTable, GUIParameterTableItem< T >::myTablePosition, and GUIParameterTableItem< T >::myValue.