ddl::mapping::SimulationTimeFunction Class Reference

Simulation time function to retrieve the last known simulation time updated by time trigger. Properties: More...

#include <time_function.h>

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

Classes
struct	SimTimeSource
	Internal Simulation time source interface. More...

Public Types
enum class	Resolution : uint8_t { us = 0 , ms = 1 , ns = 2 , s = 3 }
	The resolution of the value that is returned by a function call.
Public Types inherited from ddl::mapping::Function
using	Description = std::unordered_map<std::string, ParameterDescription>

Public Member Functions
	SimulationTimeFunction (std::string name, Properties properties, std::shared_ptr< SimTimeSource > sim_time_source)
	CTOR.
Function::Description	getDescription () const override
	Get the parameter descriptions.
std::shared_ptr< Function::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.

Detailed Description

Simulation time function to retrieve the last known simulation time updated by time trigger. Properties:

• "resolution" : "ns", "us", "ms", "s" (default "us")

Constructor & Destructor Documentation

SimulationTimeFunction()

ddl::mapping::SimulationTimeFunction::SimulationTimeFunction	(	std::string	name,
		Properties	properties,
		std::shared_ptr< SimTimeSource >	sim_time_source )

CTOR.

Parameters

name	the name of the instance
properties	the properties for the instance
sim_time_source	sim time source interface reference

Member Function Documentation

getCallable()

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

overridevirtual

Get a Function Callable.

Parameters

function_name

the function name

Returns

std::shared_ptr<const FunctionCaller>

Implements ddl::mapping::Function.

getDescription()

Function::Description ddl::mapping::SimulationTimeFunction::getDescription ( ) const

overridevirtual

Get the parameter descriptions.

Returns

Description

Implements ddl::mapping::Function.

---

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

• include/ddl/mapping/functions/time_function.h