Template Class ConstantProfileGenerator

• Defined in File ProfileGenerator.h

Inheritance Relationships

Base Type

• public Karana::Models::ProfileGenerator< T > (Template Class ProfileGenerator)

Class Documentation

template<typename T>
class ConstantProfileGenerator : public Karana::Models::ProfileGenerator<T>

A simple constant profile generator.

Template Parameters:

T – The type of object to generate a profile for.

Public Functions

inline ConstantProfileGenerator(std::string_view name, const T &value)

ConstantProfileGenerator constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

• name – The name of the ConstantProfileGenerator.

• value – The value of the ConstantProfileGenerator.

inline virtual const T &getValue(const Karana::Math::Ktime &t) override

Get the constant profile value; ignores the time argument.

Parameters:

t – The current time (not used).

Returns:

The constant profile value.

Public Members

T value

The value for constant interpolation.

Public Static Functions

static inline Karana::Core::ks_ptr<ConstantProfileGenerator> create(std::string_view name, const T &value)

ConstantProfileGenerator constructor.

Parameters:

• name – The name of the ConstantProfileGenerator.

• value – The value of the ConstantProfileGenerator.

Returns:

A pointer to the newly created instance of ConstantProfileGenerator.