ScriptInterface::Accumulators::AccumulatorBase Class Reference

#include <AccumulatorBase.hpp>

Inheritance diagram for ScriptInterface::Accumulators::AccumulatorBase:

Collaboration diagram for ScriptInterface::Accumulators::AccumulatorBase:

Public Member Functions
	AccumulatorBase ()
Variant	do_call_method (std::string const &method, VariantMap const &parameters) override
virtual std::shared_ptr< const ::Accumulators::AccumulatorBase >	accumulator () const =0
virtual std::shared_ptr<::Accumulators::AccumulatorBase >	accumulator ()=0
Public Member Functions inherited from ScriptInterface::AutoParameters< AccumulatorBase >
std::span< const boost::string_ref >	valid_parameters () const final
Variant	get_parameter (const std::string &name) const final
void	do_set_parameter (const std::string &name, const Variant &value) final
std::vector< std::pair< std::string, Variant > >	serialize_parameters () const final
Public Member Functions inherited from ScriptInterface::ObjectHandle
	ObjectHandle ()=default
	ObjectHandle (ObjectHandle const &)=delete
ObjectHandle &	operator= (ObjectHandle const &)=delete
virtual	~ObjectHandle ()=default
boost::string_ref	name () const
Context *	context () const
	Responsible context.
void	construct (VariantMap const &params)
	Construct the handled object.
virtual void	do_construct (VariantMap const &params)
VariantMap	get_parameters () const
	Get current parameters.
auto	get_valid_parameters () const
void	set_parameter (const std::string &name, const Variant &value)
	Set single parameter.
Variant	call_method (const std::string &name, const VariantMap &params)
	Call a method on the object.
std::string	serialize () const

Protected Member Functions
auto	get_core_system_pointer (VariantMap const &params) const
Protected Member Functions inherited from ScriptInterface::AutoParameters< AccumulatorBase >
	AutoParameters ()=default
	AutoParameters (std::vector< AutoParameter > &&params)
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const

Private Member Functions
std::string	get_internal_state () const override
void	set_internal_state (std::string const &state) override

Additional Inherited Members
Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef	deserialize (const std::string &state, Context &ctx)
	Make object from serialized state.

Detailed Description

Definition at line 36 of file script_interface/accumulators/AccumulatorBase.hpp.

Constructor & Destructor Documentation

AccumulatorBase()

ScriptInterface::Accumulators::AccumulatorBase::AccumulatorBase ( )

inline

Definition at line 38 of file script_interface/accumulators/AccumulatorBase.hpp.

References accumulator(), and ScriptInterface::AutoParameters< AccumulatorBase >::add_parameters().

Member Function Documentation

accumulator() [1/2]

virtual std::shared_ptr< const ::Accumulators::AccumulatorBase > ScriptInterface::Accumulators::AccumulatorBase::accumulator ( ) const

pure virtual

Implemented in ScriptInterface::Accumulators::Correlator, ScriptInterface::Accumulators::MeanVarianceCalculator, and ScriptInterface::Accumulators::TimeSeries.

Referenced by AccumulatorBase(), do_call_method(), and get_internal_state().

accumulator() [2/2]

virtual std::shared_ptr<::Accumulators::AccumulatorBase > ScriptInterface::Accumulators::AccumulatorBase::accumulator ( )

pure virtual

Implemented in ScriptInterface::Accumulators::Correlator, ScriptInterface::Accumulators::MeanVarianceCalculator, and ScriptInterface::Accumulators::TimeSeries.

do_call_method()

Variant ScriptInterface::Accumulators::AccumulatorBase::do_call_method ( std::string const &  method, VariantMap const &  parameters  )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Reimplemented in ScriptInterface::Accumulators::Correlator, ScriptInterface::Accumulators::MeanVarianceCalculator, and ScriptInterface::Accumulators::TimeSeries.

Definition at line 45 of file script_interface/accumulators/AccumulatorBase.hpp.

References accumulator().

Referenced by ScriptInterface::Accumulators::Correlator::do_call_method(), ScriptInterface::Accumulators::MeanVarianceCalculator::do_call_method(), and ScriptInterface::Accumulators::TimeSeries::do_call_method().

get_core_system_pointer()

auto ScriptInterface::Accumulators::AccumulatorBase::get_core_system_pointer ( VariantMap const &  params ) const

inlineprotected

Definition at line 63 of file script_interface/accumulators/AccumulatorBase.hpp.

References System::get_system(), and params.

Referenced by ScriptInterface::Accumulators::Correlator::do_construct(), ScriptInterface::Accumulators::MeanVarianceCalculator::do_construct(), and ScriptInterface::Accumulators::TimeSeries::do_construct().

get_internal_state()

std::string ScriptInterface::Accumulators::AccumulatorBase::get_internal_state ( ) const

inlineoverrideprivatevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 74 of file script_interface/accumulators/AccumulatorBase.hpp.

References accumulator().

set_internal_state()

void ScriptInterface::Accumulators::AccumulatorBase::set_internal_state ( std::string const &  state )

inlineoverrideprivatevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 78 of file script_interface/accumulators/AccumulatorBase.hpp.

References ScriptInterface::ObjectHandle::call_method().

---

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

• script_interface/accumulators/AccumulatorBase.hpp