Class BaseWithVars

• Defined in File BaseWithVars.h

Inheritance Relationships

Base Type

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

Derived Types

• public Karana::Collision::ContactForceBase (Class ContactForceBase)

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

• public Karana::Dynamics::CELoopKinematicsBase (Class CELoopKinematicsBase)

• public Karana::Dynamics::NodeDeformationProvider (Class NodeDeformationProvider)

• public Karana::Dynamics::TimeKeeper (Class TimeKeeper)

• public Karana::Dynamics::TimedEvent (Class TimedEvent)

• public Karana::KUtils::H5Writer (Class H5Writer)

• public Karana::KUtils::PlotData (Class PlotData)

• public Karana::Models::GravityInterface (Class GravityInterface)

• public Karana::Models::KModelContinuousStates (Class KModelContinuousStates)

• public Karana::Models::KModelDiscreteStates (Class KModelDiscreteStates)

• public Karana::Models::KModelParams (Class KModelParams)

• public Karana::Models::KModelScratch (Class KModelScratch)

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

• public Karana::Scene::AbstractStaticGeometry (Class AbstractStaticGeometry)

• public Karana::Scene::PhongMaterial (Class PhongMaterial)

• public Karana::Scene::PhysicalMaterial (Class PhysicalMaterial)

• public Karana::Scene::Scene (Class Scene)

• public Karana::Scene::SceneNode (Class SceneNode)

• public Karana::Scene::Texture (Class Texture)

Class Documentation

class BaseWithVars : public Karana::Core::Base

Common base class used by most simulation objects.

Subclassed by Karana::Collision::ContactForceBase, Karana::Core::LockingBase, Karana::Dynamics::CELoopKinematicsBase, Karana::Dynamics::NodeDeformationProvider, Karana::Dynamics::TimeKeeper, Karana::Dynamics::TimedEvent, Karana::KUtils::H5Writer, Karana::KUtils::PlotData, Karana::Models::GravityInterface, Karana::Models::KModelContinuousStates, Karana::Models::KModelDiscreteStates, Karana::Models::KModelParams, Karana::Models::KModelScratch, Karana::Models::ProfileGenerator< T >, Karana::Scene::AbstractStaticGeometry, Karana::Scene::PhongMaterial, Karana::Scene::PhysicalMaterial, Karana::Scene::Scene, Karana::Scene::SceneNode, Karana::Scene::Texture

Public Functions

BaseWithVars(std::string_view name, const ks_ptr<BaseContainer> &container = nullptr)

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

Parameters:

• name – Name for the class.

• container – The container to add the BaseWithVars too. If none is specified, the default singleton container will be used.

~BaseWithVars()

Destructor.

BaseWithVars(const BaseWithVars &other)

Copy constructor.

Parameters:

other – BaseWithVars class to copy.

BaseWithVars &operator=(const BaseWithVars &other) noexcept

Copy assignment operator.

Parameters:

other – BaseWithVars class to copy.

Returns:

A reference to this object

BaseWithVars(BaseWithVars &&other) noexcept

Move constructor.

Parameters:

other – BaseWithVars class to move.

BaseWithVars &operator=(BaseWithVars &&other) noexcept

Move assignment operator.

Parameters:

other – BaseWithVars class to move.

Returns:

A reference to this object

virtual const Karana::Core::BaseVars &getVars() const

Get vars as the most derived type.

Returns:

The vars member as its most derived type.

Public Members

ks_ptr<Karana::Core::BaseVars> vars = nullptr

Container that holds the Vars associated with this class.

Public Static Functions

static ks_ptr<BaseWithVars> create(std::string_view name)

Create an instance of BaseWithVars.

Parameters:

name – Name for the BaseWithVars class.

Returns:

A pointer to the newly created BaseWithVars class.