estar::ComparisonFacade Class Reference

#include <ComparisonFacade.hpp>

Inheritance diagram for estar::ComparisonFacade:


Public Member Functions
boost::shared_ptr< FacadeReadInterface const >	GetMaster () const
	Returns: Read access to the "master" (or ground-truth) Facade, which is the one that the "sample" is compared against.
boost::shared_ptr< FacadeReadInterface const >	GetSample () const
	Returns: Read access to the "sample" (or trial) Facade, which is the one that is compared against the "master".
virtual bool	SetMeta (ssize_t ix, ssize_t iy, double meta)
	Implements FacadeWriteInterface::SetMeta() by setting the meta on both master and sample.
virtual bool	AddGoal (ssize_t ix, ssize_t iy, double value)
	Implements FacadeWriteInterface::AddGoal() by adding the goal to both master and sample, and flagging the master for reset (unless the cell was already a goal with the same value).
virtual void	RemoveAllGoals ()
	Implements FacadeWriteInterface::RemoveAllGoals() by removing all goals from both master and sample.
virtual void	ComputeOne ()
	Implements FacadeWriteInterface::ComputeOne().
virtual void	Reset ()
	Implements FacadeWriteInterface::Reset() by resetting both master and sample.
Static Public Member Functions
static boost::shared_ptr< ComparisonFacade >	Create (const std::string &master_kernel_name, double master_scale, GridOptions const &master_grid_options, AlgorithmOptions const &master_algo_options, const std::string &sample_kernel_name, double sample_scale, GridOptions const &sample_grid_options, AlgorithmOptions const &sample_algo_options, FILE *dbgstream)
	Uses Facade::Create() to initialize two possibly different Facades.
static boost::shared_ptr< ComparisonFacade >	CreateDefault (ssize_t xsize, ssize_t ysize, double scale)
	Uses Facade::CreateDefault() to initialize two identical Facades, one will be used as master (options auto_reset and auto_flush will be enabled), the other as sample.
Private Member Functions
	ComparisonFacade (boost::shared_ptr< Facade > master, boost::shared_ptr< Facade > sample)
Private Attributes
boost::shared_ptr< Facade >	m_master
boost::shared_ptr< Facade >	m_sample

Constructor & Destructor Documentation

estar::ComparisonFacade::ComparisonFacade	(	boost::shared_ptr< Facade >	master,
		boost::shared_ptr< Facade >	sample
	)			`[private]`

Member Function Documentation

boost::shared_ptr< ComparisonFacade > estar::ComparisonFacade::Create	(	const std::string &	master_kernel_name,
		double	master_scale,
		GridOptions const &	master_grid_options,
		AlgorithmOptions const &	master_algo_options,
		const std::string &	sample_kernel_name,
		double	sample_scale,
		GridOptions const &	sample_grid_options,
		AlgorithmOptions const &	sample_algo_options,
		FILE *	dbgstream
	)			`[static]`

Uses Facade::Create() to initialize two possibly different Facades.

boost::shared_ptr< ComparisonFacade > estar::ComparisonFacade::CreateDefault	(	ssize_t	xsize,
		ssize_t	ysize,
		double	scale
	)			`[static]`

Uses Facade::CreateDefault() to initialize two identical Facades, one will be used as master (options auto_reset and auto_flush will be enabled), the other as sample.

boost::shared_ptr< FacadeReadInterface const > estar::ComparisonFacade::GetMaster ( ) const

Returns:: Read access to the "master" (or ground-truth) Facade, which is the one that the "sample" is compared against.

boost::shared_ptr< FacadeReadInterface const > estar::ComparisonFacade::GetSample ( ) const

Returns:: Read access to the "sample" (or trial) Facade, which is the one that is compared against the "master".

bool estar::ComparisonFacade::SetMeta	(	ssize_t	ix,
		ssize_t	iy,
		double	meta
	)			`[virtual]`

Implements FacadeWriteInterface::SetMeta() by setting the meta on both master and sample.

Flags the master for reset if the meta is actually changed.

Implements estar::FacadeWriteInterface.

bool estar::ComparisonFacade::AddGoal	(	ssize_t	ix,
		ssize_t	iy,
		double	value
	)			`[virtual]`

Implements FacadeWriteInterface::AddGoal() by adding the goal to both master and sample, and flagging the master for reset (unless the cell was already a goal with the same value).

Implements estar::FacadeWriteInterface.

void estar::ComparisonFacade::RemoveAllGoals ( ) [virtual]

Implements FacadeWriteInterface::RemoveAllGoals() by removing all goals from both master and sample.

Flags the master for reset.

Implements estar::FacadeWriteInterface.

void estar::ComparisonFacade::ComputeOne ( ) [virtual]

Implements FacadeWriteInterface::ComputeOne().

Forwards the call as-is to the sample. But for the master it checks for pending reset requests and then repeatedly calls its ComputeOne().

Implements estar::FacadeWriteInterface.

void estar::ComparisonFacade::Reset ( ) [virtual]

Implements FacadeWriteInterface::Reset() by resetting both master and sample.

Implements estar::FacadeWriteInterface.