LogTimeGrid Class Reference

#include <LogTimeGrid.hpp>

Inheritance diagram for LogTimeGrid:

Public Member Functions
double	maxTime () const
double	minTime () const
int	numTimes () const
double	offset () const
Public Member Functions inherited from TimeGrid
int	binForDistance (double distance) const
int	binForTime (double time) const
double	left (int k) const
int	numBins () const
Range	range () const
double	right (int k) const
double	time (int k) const
double	width (int k) const
Public Member Functions inherited from SimulationItem
template<class T>
T *	find (bool setup=true) const
template<class T>
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	LogTimeGrid ()
void	getTimeBins (vector< Bin > &bins) const override
Protected Member Functions inherited from TimeGrid
	TimeGrid ()
void	setupSelfBefore () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
double	_maxTime
double	_minTime
int	_numTimes
double	_offset

Friends
class	ItemRegistry

Detailed Description

LogTimeGrid represents logarithmically distributed time grids. The characteristic times of the grid bins are equally distributed (in log space) between and including the specified minimum and maximum time. These minimum and/or maximum time values are allowed to be negative.

The outermost bins are given the same width as the inner bins (in log space), which implies that the outermost bin borders are placed half a bin width beyond the specified minimum and maximum time. The grid must have at least two bins, which then have the specified minimum and maximum time as their respective characteristic time.

Because a logarithmic grid cannot have negative or zero values, the additional offset property specifies a value that is subtracted from each of the grid points. A positive value shifts the complete grid towards and possibly beyond the origin. A negative value shifts the grid away from the origin.

Constructor & Destructor Documentation

LogTimeGrid()

LogTimeGrid::LogTimeGrid ( )

inlineprotected

Default constructor for concrete Item subclass LogTimeGrid: "a logarithmic time grid".

Member Function Documentation

getTimeBins()

void LogTimeGrid::getTimeBins ( vector< Bin > & bins ) const

overrideprotectedvirtual

This function is invoked during setup. It places the time bins for this grid in the specified vector, which is guaranteed to be empty upon invocation.

Implements TimeGrid.

maxTime()

double LogTimeGrid::maxTime ( ) const

inline

This function returns the value of the discoverable double property maxTime: "the maximum time".

This property represents a physical quantity of type "timelag".

The minimum value for this property is "]0".

minTime()

double LogTimeGrid::minTime ( ) const

inline

This function returns the value of the discoverable double property minTime: "the minimum time".

This property represents a physical quantity of type "timelag".

The minimum value for this property is "]0".

numTimes()

int LogTimeGrid::numTimes ( ) const

inline

This function returns the value of the discoverable integer property numTimes: "the number of time grid points".

The minimum value for this property is "2".

The default value for this property is given by the conditional value expression "25".

offset()

double LogTimeGrid::offset ( ) const

inline

This function returns the value of the discoverable double property offset: "the global time offset subtracted from the grid".

This property represents a physical quantity of type "timelag".

The default value for this property is given by the conditional value expression "0".

---

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

• LogTimeGrid.hpp