Class describing a file-based exploration and its simulation tasks. More...

#include <FileExploration.h>

Inheritance diagram for SimPT_Parex::FileExploration:

Collaboration diagram for SimPT_Parex::FileExploration:

Public Member Functions
	FileExploration (const std::string &name, const std::vector< std::pair< std::string, boost::property_tree::ptree >> &files, const boost::property_tree::ptree &preferences)
	Constructor. More...

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

	FileExploration (const FileExploration &other)
	Copy constructor.

virtual	~FileExploration ()
	Destructor.

virtual FileExploration *	Clone () const
	Clone function.

virtual SimTask *	CreateTask (unsigned int index) const
	Creates a task with the parameters on the given index. More...

virtual unsigned int	GetNumberOfTasks () const
	Returns the number of tasks the exploration currently contains.

virtual std::vector< std::string >	GetParameters () const
	Returns all the parameters in the exploration.

virtual std::vector< std::string >	GetValues (unsigned int index) const
	Return the values of a certain task. More...

FileExploration &	operator= (const FileExploration &other)
	Assignment operator.

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

Public Member Functions inherited from SimPT_Parex::Exploration
	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.

const std::string &	GetName () const
	Returns the name of the exploration.

const boost::property_tree::ptree &	GetPreferences () const
	Returns the preferences of the exploration.

Exploration &	operator= (const Exploration &other)
	Assignment operator.

void	SetName (const std::string &name)
	Changes the name of the exploration. More...

Additional Inherited Members
Protected Attributes inherited from SimPT_Parex::Exploration
std::string	m_name

boost::property_tree::ptree	m_preferences

Detailed Description

Class describing a file-based exploration and its simulation tasks.

Definition at line 31 of file FileExploration.h.

Constructor & Destructor Documentation

SimPT_Parex::FileExploration::FileExploration	(	const std::string &	name,
		const std::vector< std::pair< std::string, boost::property_tree::ptree >> &	files,
		const boost::property_tree::ptree &	preferences
	)

Constructor.

Parameters

name	The name of the exploration.
files	The file names grouped with their contents.
preferences	The (workspace) preferences of the exploration.

Referenced by Clone().

Here is the caller graph for this function:

SimPT_Parex::FileExploration::FileExploration ( 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

SimTask * SimPT_Parex::FileExploration::CreateTask ( unsigned int index ) const

virtual

Creates a task with the parameters on the given index.

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

Implements SimPT_Parex::Exploration.

Definition at line 80 of file FileExploration.cpp.

References SimPT_Parex::Exploration::GetName(), GetNumberOfTasks(), and SimPT_Parex::Exploration::GetPreferences().

Here is the call graph for this function:

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

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.

Implements SimPT_Parex::Exploration.

Definition at line 68 of file FileExploration.cpp.

References GetNumberOfTasks().

Here is the call graph for this function:

ptree SimPT_Parex::FileExploration::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</preferences> (== the format of the workspace preferences) <files> <file> (for every n in m_file_names (in order)) <name>n</name> <contents> m_file_contents[n] </contents> </file> [...] </files>

Reimplemented from SimPT_Parex::Exploration.

Definition at line 88 of file FileExploration.cpp.

References SimPT_Parex::Exploration::ToPtree().

Here is the call graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation