Class CoordDataVars

Contents

Class CoordDataVars#

Defined in File CoordData.h

Inheritance Relationships#

Base Type#

public Karana::Core::LockingBaseVars (Class LockingBaseVars)

Class Documentation#

class CoordDataVars : public Karana::Core::LockingBaseVars #

The Vars for the CoordData class.

Public Functions

CoordDataVars(const kc::ks_ptr<CoordData> &cd)#

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

Parameters:: cd – The CoordData associated with this CoordDataVars.

~CoordDataVars()#: Destructor.

virtual kc::NestedVars getAllVars() const override#

Get all the Vars that this VarHolder has.

Returns:: A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<int>> n_coord_base#: number of CoordBases

kc::ks_ptr<Karana::Core::Var_T<int>> nQ#: nQ

kc::ks_ptr<Karana::Core::Var_T<int>> nU#: nU

Public Static Functions

static kc::ks_ptr<CoordDataVars> create(const kc::ks_ptr<CoordData> &cd)#

Create an instance of the CoordDataVars.

Parameters:: cd – The CoordData associated with this CoordDataVars.
Returns:: A pointer to the newly created instance of CoordDataVars.