WSF
Public Member Functions | Protected Attributes | List of all members
wsf::six_dof::SizeFactor Class Reference

#include <WsfSixDOF_SizeFactor.hpp>

Public Member Functions

 SizeFactor ()=default
void CalculateSizeFactor (double dT_sec)
void InitializeValues ()
bool IsEnabled () const
double GetSizeFactorRadius () const
void SetSizeFactorEnabled (bool aEnabled)
void SetRefSizeFactorRadius_m (double aValue_m)
void SetSizeFactorMin (double aValue)
void SetSizeFactorMax (double aValue)
void SetSizeFactorVolumeRate_m3_perSec (double aVolumeRate_m3_perSec)
void SetSizeFactorAreaRate_m2_perSec (double aAreaRate_m2_perSec)
void SetSizeFactorRadiusRate_m_perSec (double aRadiusRate_m_perSec)

Protected Attributes

bool mSizeFactorEnabled = false
bool mSizeFactorVolumeEnabled = false
bool mSizeFactorAreaEnabled = false
bool mSizeFactorRadiusEnabled = false
double mRefSizeFactorRadius_m = 1.0
double mRefSizeFactorArea_m2 = 0.0
double mRefSizeFactorVolume_m3 = 0.0
double mSizeFactorMin = 1.0
double mSizeFactorMax = 1.0
double mSizeFactorVolumeRate_m3_perSec = 0.0
double mSizeFactorAreaRate_m2_perSec = 0.0
double mSizeFactorRadiusRate_m_perSec = 0.0
double mSizeFactorVolume = 1.0
double mSizeFactorArea = 1.0
double mSizeFactorRadius = 1.0
double mCurrentSizeFactorRadius_m = 0.0
double mCurrentSizeFactorArea_m2 = 0.0
double mCurrentSizeFactorVolume_m3 = 0.0

Constructor & Destructor Documentation

◆ SizeFactor()

wsf::six_dof::SizeFactor::SizeFactor ( )
default

References CalculateSizeFactor(), and InitializeValues().

Member Function Documentation

◆ CalculateSizeFactor()

void wsf::six_dof::SizeFactor::CalculateSizeFactor ( double dT_sec)

References IsEnabled(), mCurrentSizeFactorArea_m2, mCurrentSizeFactorRadius_m, mCurrentSizeFactorVolume_m3, mRefSizeFactorArea_m2, mRefSizeFactorRadius_m, mRefSizeFactorVolume_m3, mSizeFactorArea, mSizeFactorAreaEnabled, mSizeFactorAreaRate_m2_perSec, mSizeFactorMax, mSizeFactorMin, mSizeFactorRadius, mSizeFactorRadiusRate_m_perSec, mSizeFactorVolume, mSizeFactorVolumeEnabled, and mSizeFactorVolumeRate_m3_perSec.

Referenced by SizeFactor().

◆ GetSizeFactorRadius()

double wsf::six_dof::SizeFactor::GetSizeFactorRadius ( ) const

References mSizeFactorRadius.

◆ InitializeValues()

void wsf::six_dof::SizeFactor::InitializeValues ( )

References mCurrentSizeFactorArea_m2, mCurrentSizeFactorRadius_m, mCurrentSizeFactorVolume_m3, mRefSizeFactorArea_m2, mRefSizeFactorRadius_m, and mRefSizeFactorVolume_m3.

Referenced by SizeFactor().

◆ IsEnabled()

bool wsf::six_dof::SizeFactor::IsEnabled ( ) const
inline

References mSizeFactorEnabled.

Referenced by CalculateSizeFactor().

◆ SetRefSizeFactorRadius_m()

void wsf::six_dof::SizeFactor::SetRefSizeFactorRadius_m ( double aValue_m)

References mRefSizeFactorRadius_m.

◆ SetSizeFactorAreaRate_m2_perSec()

void wsf::six_dof::SizeFactor::SetSizeFactorAreaRate_m2_perSec ( double aAreaRate_m2_perSec)

References mSizeFactorAreaEnabled, mSizeFactorAreaRate_m2_perSec, mSizeFactorRadiusEnabled, and mSizeFactorVolumeEnabled.

◆ SetSizeFactorEnabled()

void wsf::six_dof::SizeFactor::SetSizeFactorEnabled ( bool aEnabled)

References mSizeFactorEnabled.

◆ SetSizeFactorMax()

void wsf::six_dof::SizeFactor::SetSizeFactorMax ( double aValue)

References mSizeFactorMax.

◆ SetSizeFactorMin()

void wsf::six_dof::SizeFactor::SetSizeFactorMin ( double aValue)

References mSizeFactorMin.

◆ SetSizeFactorRadiusRate_m_perSec()

void wsf::six_dof::SizeFactor::SetSizeFactorRadiusRate_m_perSec ( double aRadiusRate_m_perSec)

References mSizeFactorAreaEnabled, mSizeFactorRadiusEnabled, mSizeFactorRadiusRate_m_perSec, and mSizeFactorVolumeEnabled.

◆ SetSizeFactorVolumeRate_m3_perSec()

void wsf::six_dof::SizeFactor::SetSizeFactorVolumeRate_m3_perSec ( double aVolumeRate_m3_perSec)

References mSizeFactorAreaEnabled, mSizeFactorRadiusEnabled, mSizeFactorVolumeEnabled, and mSizeFactorVolumeRate_m3_perSec.

Member Data Documentation

◆ mCurrentSizeFactorArea_m2

double wsf::six_dof::SizeFactor::mCurrentSizeFactorArea_m2 = 0.0
protected

Referenced by CalculateSizeFactor(), and InitializeValues().

◆ mCurrentSizeFactorRadius_m

double wsf::six_dof::SizeFactor::mCurrentSizeFactorRadius_m = 0.0
protected

Referenced by CalculateSizeFactor(), and InitializeValues().

◆ mCurrentSizeFactorVolume_m3

double wsf::six_dof::SizeFactor::mCurrentSizeFactorVolume_m3 = 0.0
protected

Referenced by CalculateSizeFactor(), and InitializeValues().

◆ mRefSizeFactorArea_m2

double wsf::six_dof::SizeFactor::mRefSizeFactorArea_m2 = 0.0
protected

Referenced by CalculateSizeFactor(), and InitializeValues().

◆ mRefSizeFactorRadius_m

double wsf::six_dof::SizeFactor::mRefSizeFactorRadius_m = 1.0
protected

Referenced by CalculateSizeFactor(), InitializeValues(), and SetRefSizeFactorRadius_m().

◆ mRefSizeFactorVolume_m3

double wsf::six_dof::SizeFactor::mRefSizeFactorVolume_m3 = 0.0
protected

Referenced by CalculateSizeFactor(), and InitializeValues().

◆ mSizeFactorArea

double wsf::six_dof::SizeFactor::mSizeFactorArea = 1.0
protected

Referenced by CalculateSizeFactor().

◆ mSizeFactorAreaEnabled

bool wsf::six_dof::SizeFactor::mSizeFactorAreaEnabled = false
protected

Referenced by CalculateSizeFactor(), SetSizeFactorAreaRate_m2_perSec(), SetSizeFactorRadiusRate_m_perSec(), and SetSizeFactorVolumeRate_m3_perSec().

◆ mSizeFactorAreaRate_m2_perSec

double wsf::six_dof::SizeFactor::mSizeFactorAreaRate_m2_perSec = 0.0
protected

Referenced by CalculateSizeFactor(), and SetSizeFactorAreaRate_m2_perSec().

◆ mSizeFactorEnabled

bool wsf::six_dof::SizeFactor::mSizeFactorEnabled = false
protected

Referenced by IsEnabled(), and SetSizeFactorEnabled().

◆ mSizeFactorMax

double wsf::six_dof::SizeFactor::mSizeFactorMax = 1.0
protected

Referenced by CalculateSizeFactor(), and SetSizeFactorMax().

◆ mSizeFactorMin

double wsf::six_dof::SizeFactor::mSizeFactorMin = 1.0
protected

Referenced by CalculateSizeFactor(), and SetSizeFactorMin().

◆ mSizeFactorRadius

double wsf::six_dof::SizeFactor::mSizeFactorRadius = 1.0
protected

Referenced by CalculateSizeFactor(), and GetSizeFactorRadius().

◆ mSizeFactorRadiusEnabled

bool wsf::six_dof::SizeFactor::mSizeFactorRadiusEnabled = false
protected

Referenced by SetSizeFactorAreaRate_m2_perSec(), SetSizeFactorRadiusRate_m_perSec(), and SetSizeFactorVolumeRate_m3_perSec().

◆ mSizeFactorRadiusRate_m_perSec

double wsf::six_dof::SizeFactor::mSizeFactorRadiusRate_m_perSec = 0.0
protected

Referenced by CalculateSizeFactor(), and SetSizeFactorRadiusRate_m_perSec().

◆ mSizeFactorVolume

double wsf::six_dof::SizeFactor::mSizeFactorVolume = 1.0
protected

Referenced by CalculateSizeFactor().

◆ mSizeFactorVolumeEnabled

bool wsf::six_dof::SizeFactor::mSizeFactorVolumeEnabled = false
protected

Referenced by CalculateSizeFactor(), SetSizeFactorAreaRate_m2_perSec(), SetSizeFactorRadiusRate_m_perSec(), and SetSizeFactorVolumeRate_m3_perSec().

◆ mSizeFactorVolumeRate_m3_perSec

double wsf::six_dof::SizeFactor::mSizeFactorVolumeRate_m3_perSec = 0.0
protected

Referenced by CalculateSizeFactor(), and SetSizeFactorVolumeRate_m3_perSec().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved