SweepController Class Reference

#include <SweepController.h>

Inheritance diagram for SweepController:

Collaboration diagram for SweepController:

Classes
struct	Input

Public Member Functions
	SweepController (const Input &input_obj)
virtual	~SweepController () override=default
virtual void	iterate () override
virtual Command	getSimulator () const override
Public Member Functions inherited from AbstractController
	AbstractController ()=default
virtual	~AbstractController ()=default
void	assignMaster (std::shared_ptr< AbstractMaster > p_master)

Static Public Member Functions
static std::string	help ()
static void	addLongOptions (LongOptions &lopts)
static SweepController *	makeController (const Arguments &args)
Static Public Member Functions inherited from AbstractController
static controller_t	getController (const std::string &arg)
static std::string	help (controller_t controller)
static void	addLongOptions (controller_t controller, LongOptions &lopts)
static AbstractController *	makeController (controller_t controller, const Arguments &args)

Additional Inherited Members
Protected Attributes inherited from AbstractController
std::shared_ptr< AbstractMaster >	m_p_master

Detailed Description

A Controller class implementing a simple parameter sweep algorithm.

The SweepController class implements a simple parameter sweep algorithm. The parameter sets to simulate are given by the Input::generator command. The simulator is then called for each of these parameter sets, and the output of the simulator is discarded.

For instructions on how to use Pakman with the sweep controller, execute the following command

$ pakman sweep --help

Definition at line 25 of file SweepController.h.

Constructor & Destructor Documentation

SweepController()

SweepController::SweepController

(

const Input &

input_obj

)

Construct from Input object.

Parameters

input_obj

Input object.

Definition at line 17 of file SweepController.cc.

~SweepController()

virtual SweepController::~SweepController ( )

overridevirtualdefault

Default destructor does nothing.

Member Function Documentation

addLongOptions()

void SweepController::addLongOptions ( LongOptions &  lopts )

static

Add long command-line options.

Parameters

lopts

long command-line options that the SweepController needs.

Definition at line 33 of file SweepControllerStatic.cc.

getSimulator()

Command SweepController::getSimulator ( ) const

overridevirtual

Returns

simulator command.

Implements AbstractController.

Definition at line 98 of file SweepController.cc.

help()

std::string SweepController::help ( )

static

Returns

help message string.

Definition at line 13 of file SweepControllerStatic.cc.

iterate()

void SweepController::iterate ( )

overridevirtual

Iterates the SweepController. Should be called by a Master.

Implements AbstractController.

Definition at line 35 of file SweepController.cc.

makeController()

SweepController * SweepController::makeController ( const Arguments &  args )

static

Create SweepController instance.

Parameters

args	command-line arguments.

Returns

pointer to created SweepController instance.

Definition at line 40 of file SweepControllerStatic.cc.

---

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

• src/controller/SweepController.h
• src/controller/SweepController.cc
• src/controller/SweepControllerStatic.cc