Was received function to retrieve if at least the given source with name was received. The callable will return a bool value. More...

#include <engine_function.h>

Inherits ddl::mapping::MapperElementBase< Function >.

Public Member Functions
	WasReceivedFunction ()=delete
	CTOR deleted.

	WasReceivedFunction (std::string name, Properties properties)
	CTOR.

Description	getDescription () const override
	Get the parameter descriptions.

std::shared_ptr< Callable >	getCallable () const override
	Get a Function Callable.

Public Member Functions inherited from ddl::mapping::MapperElementBase< Function >
	MapperElementBase (std::string name, Properties properties)
	CTOR.

	~MapperElementBase () override=default
	DTOR.

const std::string &	getName () const override
	Get the Name.

const Properties &	getProperties () const override
	Get the Properties.

const Property &	getProperty (const std::string &property_name) const
	Get the Property.

Public Member Functions inherited from ddl::mapping::MapperElement
virtual	~MapperElement ()=default
	DTOR.

Static Public Member Functions
static std::string	getType ()
	Get the Type as string to register within factory.

static Properties	getDefaultProperties ()
	Get the Default Properties to register within factory.

Additional Inherited Members
Public Types inherited from ddl::mapping::Function
using	Description = std::unordered_map<std::string, ParameterDescription>

Detailed Description

Was received function to retrieve if at least the given source with name was received. The callable will return a bool value.

Constructor & Destructor Documentation

◆ WasReceivedFunction()

ddl::mapping::WasReceivedFunction::WasReceivedFunction	(	std::string	name,
		Properties	properties )

CTOR.

Parameters

name	the name of the instance
properties	the properties for the instance

Member Function Documentation

◆ getCallable()

std::shared_ptr< Callable > ddl::mapping::WasReceivedFunction::getCallable ( ) const

overridevirtual

Get a Function Callable.

Parameters

function_name the function name

Returns: std::shared_ptr<const FunctionCaller>

Implements ddl::mapping::Function.

◆ getDefaultProperties()

static Properties ddl::mapping::WasReceivedFunction::getDefaultProperties ( )

inlinestatic

Get the Default Properties to register within factory.

Returns: Properties

◆ getDescription()

Description ddl::mapping::WasReceivedFunction::getDescription ( ) const

overridevirtual

Get the parameter descriptions.

Returns: Description

Implements ddl::mapping::Function.

◆ getType()

static std::string ddl::mapping::WasReceivedFunction::getType ( )

inlinestatic

Get the Type as string to register within factory.

Returns: std::string

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

include/ddl/mapping/functions/engine_function.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members