FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
CSaturation Class Reference
+ Inheritance diagram for CSaturation:
+ Collaboration diagram for CSaturation:

Public Member Functions

 CSaturation (std::string sSimObjectName, ISimObjectCreator *pCreator)
 Constructor.
 
virtual void OdeFcn (const double dT, const double *const adX, double *const adXDot) const
 
const double * Output (const double T, const double *const X)
 
- Public Member Functions inherited from fhsim_base::SignalBlock
 SignalBlock (const std::string &name, ISimObjectCreator *creator, PortWidthRule rule=PortWidthRule::DefaultOne)
 

Protected Attributes

ISignalPort * m_Input
 
std::vector< double > m_MaxVals
 
std::vector< double > m_MinVals
 
- Protected Attributes inherited from fhsim_base::SignalBlock
std::vector< double > m_out
 The output buffer, PortWidth() elements. A block may resize it, for example to the width of an output port that differs from PortWidth.
 

Additional Inherited Members

- Public Types inherited from fhsim_base::SignalBlock
enum class  PortWidthRule { DefaultOne , Required }
 Whether the parameter PortWidth must be in the input file. More...
 
- Static Public Member Functions inherited from fhsim_base::SignalBlock
static int ReadCount (ISimObjectCreator *creator, const std::string &name, int defaultValue)
 
static int ReadCount (ISimObjectCreator *creator, const std::string &name)
 As above for a count that must be in the file.
 
- Protected Member Functions inherited from fhsim_base::SignalBlock
int PortWidth () const
 The number of elements in the signals of the block (the parameter PortWidth).
 
std::vector< double > ReadScalarOrVector (ISimObjectCreator *creator, const std::string &name, double defaultValue) const
 
std::vector< double > ReadScalarOrVector (ISimObjectCreator *creator, const std::string &name) const
 

Member Data Documentation

◆ m_MaxVals

std::vector<double> CSaturation::m_MaxVals
protected

The upper saturation value with size 1 (scalar saturation) or <PortWidth> (individual component saturation)

◆ m_MinVals

std::vector<double> CSaturation::m_MinVals
protected

The lower saturation value with size 1 (scalar saturation) or <PortWidth> (individual component saturation


The documentation for this class was generated from the following file: