CRamp Class Reference

#include <CRamp.h>

Inheritance diagram for CRamp:

Collaboration diagram for CRamp:

Public Member Functions
	CRamp (std::string sSimObjectName, ISimObjectCreator *pCreator)
	The constructor sets the pointer to the output object and the parser object.
Public Member Functions inherited from CSrcBase
	CSrcBase (std::string sSimObjectName, ISimObjectCreator *pCreator)
	The constructor.
virtual	~CSrcBase ()
	The destructor.
virtual void	OdeFcn (const double dT, const double *const adX, double *const adXDot, const bool bIsMajorTimeStep)
	Calculates the state derivatives.

Protected Member Functions
void	CalcOutput (const double dT, const double *const adX)
	Calculations of the output signals.
Protected Member Functions inherited from CSrcBase
void	ReadParameter (std::string sTag, double *adVals, double dDefault, ISimObjectCreator *pCreator)
	Utility function to read a parameter.
bool	ReadTwinParameters (std::string sTagA, double dDefaultA, std::string sTagB, double dDefaultB, double *adVals, ISimObjectCreator *pCreator)
	Utility function to read a parameter with two possible representations or units.
virtual const double *	Signal (const double dT, const double *const adX)
	The output signal.
virtual const double *	SignalDot (const double dT, const double *const adX)
	The derivative of the output signal.

Protected Attributes
double *	m_adStartValues
double *	m_adStopValues
double *	m_adStartTimes
double *	m_adStopTimes
Protected Attributes inherited from CSrcBase
double *	m_adOutSignal
	The output signal.
double *	m_adOutSignalDot
	The derivative of the output signal.
int	m_iPortWidth
	The width of the output port.
sfh::timers::Timer	m_OutputTimer
	Timer to ensure that signals are updated only once per timestep.

Detailed Description

Author

Karl-Johan Reite and Vegar Johansen

This is a ramp simObject. It has no input port, and has two output ports with a scalar or vector signal. One is the ramp signal, and the other is the signal's derivative. The initial value, the final value, the start time and the end time are decided by input parameters at run-time.

Simobject name for use in input file: Src/Ramp

Parameters

Parameter	Default	Comment
PortWidth	1	The number of elements in the signal.
StartValue	0	The start value of the output port. This may either be a scalar, or a comma separated list referring to the different elements of the signal.
StopValue	1	The stop value of the output port. This may either be a scalar, or a comma separated list referring to the different elements of the signal.
StartTime	1	The time to start the step. This may either be a scalar, or a comma separated list referring to the different elements of the signal.
StopTime	-1	The time to stop the step. This may either be a scalar, or a comma separated list referring to the different elements of the signal. If this is negative, this is a true step function with unlimited duration. If it is larger than zero, it is a pulse function, which goes back to the StartValue after the StopTime.

Member Function Documentation

CalcOutput()

void CRamp::CalcOutput ( const double  dT, const double *const  adX  )

protectedvirtual

Implements CSrcBase.

Member Data Documentation

m_adStartTimes

double* CRamp::m_adStartTimes

protected

The time to start the step. This may either be a scalar, or a comma separated list referring to the different elements of the signal.

m_adStartValues

double* CRamp::m_adStartValues

protected

The start value of the output port. This may either be a scalar, or a comma separated list referring to the different elements of the signal.

m_adStopTimes

double* CRamp::m_adStopTimes

protected

The time to stop the step. This may either be a scalar, or a comma separated list referring to the different elements of the signal. If this is negative, this is a true step function with unlimited duration. If it is larger than zero, it is a pulse function, which goes back to the StartValue after the StopTime.

m_adStopValues

double* CRamp::m_adStopValues

protected

The stop value of the output port. This may either be a scalar, or a comma separated list referring to the different elements of the signal.

---

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

• /update_root/webfhsim/reloadrepos/fhsim_base/src/source/CRamp.h