A sweep over a range of numerical parameters. More...

#include <RangeSweep.h>

Inheritance diagram for SimPT_Parex::RangeSweep:

Collaboration diagram for SimPT_Parex::RangeSweep:

Public Member Functions
	RangeSweep (double from, double to, double step)
	Constructor. More...

	RangeSweep (const boost::property_tree::ptree &pt)
	Constructor. More...

virtual RangeSweep *	Clone () const
	Polymorphic copy constructor.

double	GetFrom () const
	Gets the from value of the range.

virtual unsigned int	GetNumberOfValues () const
	Returns the number of values in the sweep.

double	GetStep () const
	Gets the step value of the range.

double	GetTo () const
	Gets the to value of the range.

virtual std::string	GetValue (unsigned int index) const
	Returns the value on the given index. More...

virtual boost::property_tree::ptree	ToPtree () const
	Convert the range sweep to a ptree. More...

Detailed Description

A sweep over a range of numerical parameters.

Definition at line 29 of file RangeSweep.h.

Constructor & Destructor Documentation

SimPT_Parex::RangeSweep::RangeSweep	(	double	from,
		double	to,
		double	step
	)

Constructor.

Parameters

from	The value the sweep starts from.
to	The value the sweep ends.
step	The step size of the sweep.

Definition at line 29 of file RangeSweep.cpp.

Referenced by Clone().

Here is the caller graph for this function:

SimPT_Parex::RangeSweep::RangeSweep ( const boost::property_tree::ptree & pt )

Constructor.

Contains the information for a range sweep. See ToPtree() for more information about the format.

Exceptions

ptree_bad_data	When the ptree doesn't have the correct data.
ptree_bad_path	When the ptree doesn't have the correct format.

Definition at line 34 of file RangeSweep.cpp.

string SimPT_Parex::RangeSweep::GetValue ( unsigned int index ) const

virtual

Returns the value on the given index.

The index is the position of the value if the range is written down from 'm_from' to 'm_to'.

Definition at line 39 of file RangeSweep.cpp.

Here is the call graph for this function:

ptree SimPT_Parex::RangeSweep::ToPtree ( ) const

virtual

Convert the range sweep to a ptree.

The format of a range sweep ptree is as follows: <range> <from>m_from</from> <to>m_to</to> <step>m_step</step> </range>

Definition at line 53 of file RangeSweep.cpp.

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