FileTimeGrid Class Reference

#include <FileTimeGrid.hpp>

Inheritance diagram for FileTimeGrid:

Public Member Functions
string	filename () 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
	FileTimeGrid ()
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
string	_filename

Friends
class	ItemRegistry

Detailed Description

FileTimeGrid represents time grids loaded from an input file. The floating point numbers in the first three columns of the text file specify respectively the characteristic time, the left border, and the right border of each bin. The default unit is second (s), but this can be overridden by a column header (see TextInFile). Any additional columns in the file are ignored.

The bins must be non-empty and non-overlapping, and must be sorted in increasing time order. It is allowed to have gaps between the bins. For a formal statement of the requirements, see TimeGrid. Note that time values are allowed to be negative.

Note

When specifying consecutive "touching" bins, make sure that the right border of the first bin is exactly equal to the left border of the second bin to the precision of the values listed in the input file. if not, the import might fail because the bins are considered to overlap, or there will be an unintended (small) gap in the time grid.

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

FileTimeGrid()

FileTimeGrid::FileTimeGrid ( )

inlineprotected

Default constructor for concrete Item subclass FileTimeGrid: "a time grid loaded from a text file".

Member Function Documentation

filename()

string FileTimeGrid::filename ( ) const

inline

This function returns the value of the discoverable string property filename: "the name of the file with the time bins".

getTimeBins()

void FileTimeGrid::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.

---

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

• FileTimeGrid.hpp
• LinTimeGrid.hpp
• LogTimeGrid.hpp