Standard Average Processing Recipe. More...

#include <recipeAverage.hpp>

Inheritance diagram for ifw::ccf::stdrecipe::RecipeAverage:

Public Member Functions
	RecipeAverage (const std::string &proc_thread_name, const std::string &recipe_name)

	RecipeAverage ()

virtual	~RecipeAverage ()

virtual void	InitialiseUser ()
	Initialise the recipe object. See "Initialise()".

virtual void	EnableUser ()

virtual void	DisableUser ()

virtual void	ProcessUser (ifw::ccf::common::DataFrame &frame)
	User specific processing.

virtual void	HandleSetupUser ()
	User-specific setup handling. Override in derived classes to perform custom reset logic.

virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_object)

Public Member Functions inherited from ifw::ccf::common::RecipeBase
	RecipeBase (const std::string &proc_thread_name, const std::string &recipe_name)

	RecipeBase ()

virtual	~RecipeBase ()

void	Initialise ()
	Initalise the object. Invoked after creating a new object from the factory object.

bool	GetInitialised () const
	Return flag indicating if the recipe object has been initialised.

const std::string &	GetRecipeId () const
	Get the ID of the recipe.

const std::string &	GetProcThreadName () const
	Get the name of the Processing Thread, hosting the Recipe instance.

const std::string &	GetRecipeName () const
	Get the name of the recipe.

const std::string &	GetDbPath () const
	Generate DB path for this recipe.

void	Process (DataFrame &frame)
	Execute the processing of the given frame.

void	Enable ()
	Enable the recipe so that it will be invoked by the Processing Thread to which it belongs.

void	Disable ()

bool	GetEnabled () const
	Return the enabled status of the recipe.

virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_object)
	Instantiate a specific instance of the object.

void	SetStatus (const ProcStatus status)
	Update status for a given Publisher Thread in the OLDB.

ProcStatus	GetStatus () const
	Get status of the recipe object.

void	HandleSetup ()

Public Member Functions inherited from ifw::ccf::Base
	Base ()

	~Base ()

const std::string &	GetClassName () const
	Return the allocated name of the class.

Public Attributes
const std::string	SETUP_KEY_WINDOW_SIZE = "window_size"

Additional Inherited Members
Static Public Member Functions inherited from ifw::ccf::common::RecipeBase
static const std::string &	GenId (const std::string &proc_thread_name, const std::string &recipe_name)
	Generate the ID for this recipe from the Processing Thread and Recipe number.

template<class TYPE>
static void	AddRecipeFactoryObj (TYPE &recipe_factory_obj)
	Static method to register a Data Publisher factory object in the internal registry.

static const std::map< std::string, std::shared_ptr< RecipeBase > > &	GetRecipeFactoryObjs ()
	Statis method to retrieve references to the Recipe Factory Objects.

static void	CreateRecipeObj (const std::string &class_name, const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_obj)

static void	GetRecipeObj (const std::string &class_name, const std::string &proc_thread_name, std::shared_ptr< RecipeBase > &recipe_obj, const bool initialise=true)

static const std::map< std::string, std::shared_ptr< RecipeBase > > &	GetRecipeObjs ()
	Get reference to all Processing Recipe objects registered.

static bool	HasRecipeObj (const std::string &class_name, const std::string &proc_thread_name, std::shared_ptr< RecipeBase > &recipe_obj)
	Check if a Proc Recipe object is defined.

Static Public Member Functions inherited from ifw::ccf::Base
static ifw::ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton).

Protected Member Functions inherited from ifw::ccf::common::RecipeBase
void	SetEnabled (const bool enabled)
	Set the enabled status flag of the recipe object.

void	DisableRecipe ()
	Disable the recipe so that it will not be invoked.

Protected Member Functions inherited from ifw::ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.

Detailed Description

Standard Average Processing Recipe.

Produces an average image based on a sliding window of N samples (images).

Constructor & Destructor Documentation

◆ RecipeAverage() [1/2]

ifw::ccf::stdrecipe::RecipeAverage::RecipeAverage	(	const std::string &	proc_thread_name,
		const std::string &	recipe_name )

◆ RecipeAverage() [2/2]

ifw::ccf::stdrecipe::RecipeAverage::RecipeAverage ( )

◆ ~RecipeAverage()

ifw::ccf::stdrecipe::RecipeAverage::~RecipeAverage ( )

virtual

Member Function Documentation

◆ CreateObjectUser()

void ifw::ccf::stdrecipe::RecipeAverage::CreateObjectUser	(	const std::string &	proc_thread_name,
		const std::string &	recipe_name,
		std::shared_ptr< RecipeBase > &	new_object )

virtual

◆ DisableUser()

void ifw::ccf::stdrecipe::RecipeAverage::DisableUser ( )

virtual

Specific implement of disable method. Need normally not be implemented by the user.

Reimplemented from ifw::ccf::common::RecipeBase.

◆ EnableUser()

void ifw::ccf::stdrecipe::RecipeAverage::EnableUser ( )

virtual

Specific implement of enable method. Need normally not be implemented by the user.

Reimplemented from ifw::ccf::common::RecipeBase.

◆ HandleSetupUser()

void ifw::ccf::stdrecipe::RecipeAverage::HandleSetupUser ( )

virtual

User-specific setup handling. Override in derived classes to perform custom reset logic.

Reimplemented from ifw::ccf::common::RecipeBase.

◆ InitialiseUser()

void ifw::ccf::stdrecipe::RecipeAverage::InitialiseUser ( )

virtual

Initialise the recipe object. See "Initialise()".

Reimplemented from ifw::ccf::common::RecipeBase.

◆ ProcessUser()

void ifw::ccf::stdrecipe::RecipeAverage::ProcessUser ( ifw::ccf::common::DataFrame & frame )

virtual

User specific processing.

Reimplemented from ifw::ccf::common::RecipeBase.

Member Data Documentation

◆ SETUP_KEY_WINDOW_SIZE

const std::string ifw::ccf::stdrecipe::RecipeAverage::SETUP_KEY_WINDOW_SIZE = "window_size"

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

stdrecipe/src/include/ifw/ccf/stdrecipe/recipeAverage.hpp
stdrecipe/src/recipeAverage.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RecipeAverage() [1/2]

◆ RecipeAverage() [2/2]

◆ ~RecipeAverage()

Member Function Documentation

◆ CreateObjectUser()

◆ DisableUser()

◆ EnableUser()

◆ HandleSetupUser()

◆ InitialiseUser()

◆ ProcessUser()

Member Data Documentation

◆ SETUP_KEY_WINDOW_SIZE