SimPT_Parex::Exploration Class Reference

Class describing a generic exploration. More...

#include <Exploration.h>

Inheritance diagram for SimPT_Parex::Exploration:

Collaboration diagram for SimPT_Parex::Exploration:

Public Member Functions
	Exploration (const std::string &name, const boost::property_tree::ptree &preferences)
	Constructor. More...
	Exploration (const boost::property_tree::ptree &pt)
	Constructor. More...
	Exploration (const Exploration &other)
	Copy constructor.
virtual	~Exploration ()
	Destructor.
virtual Exploration *	Clone () const =0
	Clone function.
virtual SimTask *	CreateTask (unsigned int index) const =0
	Creates a task with the parameters on the given index. More...
const std::string &	GetName () const
	Returns the name of the exploration.
virtual unsigned int	GetNumberOfTasks () const =0
	Returns the number of tasks the exploration currently contains.
virtual std::vector< std::string >	GetParameters () const =0
	Returns all the parameters in the exploration.
const boost::property_tree::ptree &	GetPreferences () const
	Returns the preferences of the exploration.
virtual std::vector< std::string >	GetValues (unsigned int index) const =0
	Return the values of a certain task. More...
Exploration &	operator= (const Exploration &other)
	Assignment operator.
void	SetName (const std::string &name)
	Changes the name of the exploration. More...
virtual boost::property_tree::ptree	ToPtree () const
	Convert the exploration to a ptree. More...

Protected Attributes
std::string	m_name
boost::property_tree::ptree	m_preferences

Detailed Description

Class describing a generic exploration.

Definition at line 33 of file Exploration.h.

Constructor & Destructor Documentation

SimPT_Parex::Exploration::Exploration	(	const std::string &	name,
		const boost::property_tree::ptree &	preferences
	)

Constructor.

Parameters

name	The name of the exploration.
preferences	The (workspace) preferences of the exploration.

SimPT_Parex::Exploration::Exploration

(

const boost::property_tree::ptree &

pt

)

Constructor.

Constructs a new exploration with the given pt. See ToPtree() for more information about the format of such a tree.

Member Function Documentation

virtual SimTask* SimPT_Parex::Exploration::CreateTask ( unsigned int  index ) const

pure virtual

Creates a task with the parameters on the given index.

This index is based on the Cartesian product of the exploration parameters.

Implemented in SimPT_Parex::ParameterExploration, and SimPT_Parex::FileExploration.

Referenced by SimPT_Parex::ExplorationProgress::NextTask().

Here is the caller graph for this function:

virtual std::vector<std::string> SimPT_Parex::Exploration::GetValues ( unsigned int  index ) const

pure virtual

Return the values of a certain task.

The index of a value associated with a parameter in the vector is the same as the index of this parameter.

Parameters

index

The task index.

Implemented in SimPT_Parex::ParameterExploration, and SimPT_Parex::FileExploration.

Referenced by SimPT_Parex::TaskOverview::UpdateExploration().

Here is the caller graph for this function:

void SimPT_Parex::Exploration::SetName ( const std::string &  name )

inline

Changes the name of the exploration.

Parameters

name	The new name of the exploration.

Definition at line 74 of file Exploration.h.

Referenced by SimPT_Parex::ServerClientProtocol::ReceivePtree().

Here is the caller graph for this function:

ptree SimPT_Parex::Exploration::ToPtree ( ) const

virtual

Convert the exploration to a ptree.

The format of an exploration ptree is as follows: <name>m_name</name> <preferences> m_preferences (== the format of the workspace preferences) </preferences>

Reimplemented in SimPT_Parex::ParameterExploration, and SimPT_Parex::FileExploration.

Definition at line 51 of file Exploration.cpp.

Referenced by SimPT_Parex::ClientProtocol::SendExploration(), SimPT_Parex::FileExploration::ToPtree(), SimPT_Parex::ParameterExploration::ToPtree(), and SimPT_Parex::ExplorationProgress::ToPtree().

Here is the caller graph for this function:

---

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

• Exploration.h
• Exploration.cpp