Template Class ProfileGeneratorVars

• Defined in File ProfileGenerator.h

Inheritance Relationships

Base Type

• public Karana::Core::BaseVars (Class BaseVars)

Class Documentation

template<typename T>
class ProfileGeneratorVars : public Karana::Core::BaseVars

Vars for the ProfileGenerator class.

Template Parameters:

T – The numeric type used in the ProfileGenerator.

Public Functions

inline ProfileGeneratorVars(const Karana::Core::ks_ptr<const ProfileGenerator<T>> &profile_generator)

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

Parameters:

profile_generator – The ProfileGenerator associated with this ProfileGeneratorVars.

inline ~ProfileGeneratorVars()

Destructor.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<km::Vec>> getQ(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<T>> getQ(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<km::Vec>> getU(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the U value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<T>> getU(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the U value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<km::Vec>> getUdot(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the Udot value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

inline Karana::Core::ks_ptr<Karana::Core::Var_T<T>> getUdot(const Karana::Core::ks_ptr<Karana::Dynamics::ModelManager> &mm) const

Get a Var that gives the Udot value of this ProfileGenerator at the provided ModelManager’s current time.

Parameters:

mm – The ModelManager to use to get time from.

Returns:

A Var that gives the Q value of this ProfileGenerator at the provided ModelManager’s current time.

Public Static Functions

static inline Karana::Core::ks_ptr<ProfileGeneratorVars<T>> create(const Karana::Core::ks_ptr<const ProfileGenerator<T>> &profile_generator)

Create an instance of the ProfileGeneratorVars.

Parameters:

profile_generator – The ProfileGenerator associated with this ProfileGeneratorVars.

Returns:

A pointer to the newly created instance of ProfileGeneratorVars.