RampDriveCaller Class Reference

#include <drive_.h>

Inheritance diagram for RampDriveCaller:

Collaboration diagram for RampDriveCaller:

Public Member Functions
	RampDriveCaller (const DriveHandler *pDH, doublereal d1, doublereal d2, doublereal d3, doublereal d4)
	~RampDriveCaller (void)
virtual DriveCaller *	pCopy (void) const
virtual std::ostream &	Restart (std::ostream &out) const
doublereal	dGet (const doublereal &dVar) const
virtual bool	bIsDifferentiable (void) const
virtual doublereal	dGetP (const doublereal &dVar) const
Public Member Functions inherited from DriveCaller
	DriveCaller (const DriveHandler *pDH)
virtual	~DriveCaller (void)
virtual doublereal	dGet (void) const
virtual doublereal	dGetP (void) const
virtual void	SetDrvHdl (const DriveHandler *pDH)
virtual const DriveHandler *	pGetDrvHdl (void) const
virtual void	Output (OutputHandler &OH) const
virtual void	Trace (OutputHandler &OH) const
Public Member Functions inherited from WithLabel
	WithLabel (unsigned int uL=0, const std::string &sN="")
virtual	~WithLabel (void)
void	PutLabel (unsigned int uL)
void	PutName (const std::string &sN)
unsigned int	GetLabel (void) const
const std::string &	GetName (void) const
Public Member Functions inherited from ToBeOutput
	ToBeOutput (flag fOut=fDefaultOut)
virtual	~ToBeOutput (void)
virtual void	OutputPrepare (OutputHandler &OH)
virtual void	Output (OutputHandler &OH, const VectorHandler &X, const VectorHandler &XP) const
virtual flag	fToBeOutput (void) const
virtual bool	bToBeOutput (void) const
virtual void	SetOutputFlag (flag f=flag(1))
Public Member Functions inherited from Traceable
	Traceable (flag fTrace=0)
virtual	~Traceable (void)
virtual flag	fToBeTraced (void) const
virtual void	SetTraceFlag (flag f=TRACE)

Private Attributes
doublereal	dSlope
doublereal	dStartTime
doublereal	dEndTime
doublereal	dInitialValue

Additional Inherited Members
Public Types inherited from DriveCaller
enum	OutputFlags { OUTPUT_VALUE = OUTPUT_PRIVATE << 0, OUTPUT_DERIVATIVE = OUTPUT_PRIVATE << 1 }
enum	TraceFlags { TRACE_VALUE = TRACE_PRIVATE << 0, TRACE_DERIVATIVE = TRACE_PRIVATE << 1 }
Public Types inherited from ToBeOutput
enum	{ OUTPUT = 0x1U, OUTPUT_MASK = 0xFU, OUTPUT_PRIVATE = 0x10U, OUTPUT_PRIVATE_MASK = ~OUTPUT_MASK }
Public Types inherited from Traceable
enum	{ TRACE = 0x01U, TRACE_PUBLIC_MASK = 0x0FU, TRACE_PRIVATE = 0x10U, TRACE_PRIVATE_MASK = ~TRACE_PUBLIC_MASK }
Protected Attributes inherited from DriveCaller
DriveHandler *	pDrvHdl
Protected Attributes inherited from WithLabel
unsigned int	uLabel
std::string	sName
Protected Attributes inherited from ToBeOutput
flag	fOutput

Detailed Description

Definition at line 574 of file drive_.h.

Constructor & Destructor Documentation

RampDriveCaller::RampDriveCaller	(	const DriveHandler *	pDH,
		doublereal	d1,
		doublereal	d2,
		doublereal	d3,
		doublereal	d4
	)

Definition at line 466 of file drive_.cc.

References NO_OP.

Referenced by pCopy().

: DriveCaller(pDH), dSlope(d1), dStartTime(d2), dEndTime(d3), dInitialValue(d4)
{
        NO_OP;
}

RampDriveCaller::~RampDriveCaller

(

void

)

Definition at line 473 of file drive_.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

bool RampDriveCaller::bIsDifferentiable ( void  ) const

inlinevirtual

Reimplemented from DriveCaller.

Definition at line 628 of file drive_.h.

{
        return true;
}

doublereal RampDriveCaller::dGet ( const doublereal &  dVar ) const

inlinevirtual

Implements DriveCaller.

Definition at line 606 of file drive_.h.

References dEndTime, dInitialValue, dSlope, and dStartTime.

{
        doublereal dVal;

        dVal = dInitialValue;
        if (dVar > dStartTime) {
                doublereal dEnd;

                if (dVar > dEndTime) {
                        dEnd = dEndTime;

                } else {
                        dEnd = dVar;
                }

                dVal += dSlope*(dEnd - dStartTime);
        }

        return dVal;
}

doublereal RampDriveCaller::dGetP ( const doublereal &  dVar ) const

inlinevirtual

Reimplemented from DriveCaller.

Definition at line 634 of file drive_.h.

References dEndTime, dSlope, and dStartTime.

{
        if (dVar < dStartTime || dVar > dEndTime) {
                return 0.;
        }

        if (dVar == dStartTime || dVar == dEndTime) {
                return dSlope/2.;
        }

        return dSlope;
}

DriveCaller * RampDriveCaller::pCopy ( void  ) const

virtual

Implements DriveCaller.

Definition at line 480 of file drive_.cc.

References dEndTime, dInitialValue, dSlope, dStartTime, DriveCaller::pDrvHdl, RampDriveCaller(), and SAFENEWWITHCONSTRUCTOR.

{
        DriveCaller* pDC = 0;
        SAFENEWWITHCONSTRUCTOR(pDC,
                RampDriveCaller,
                RampDriveCaller(pDrvHdl, dSlope, dStartTime, dEndTime, dInitialValue));
        return pDC;
}

Here is the call graph for this function:

std::ostream & RampDriveCaller::Restart ( std::ostream &  out ) const

virtual

Implements DriveCaller.

Definition at line 491 of file drive_.cc.

References dEndTime, dInitialValue, dSlope, and dStartTime.

{
        return out
                << "ramp, " << dSlope
                << ", " << dStartTime
                << ", " << dEndTime
                << ", " << dInitialValue;
}

Member Data Documentation

doublereal RampDriveCaller::dEndTime

private

Definition at line 578 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

doublereal RampDriveCaller::dInitialValue

private

Definition at line 579 of file drive_.h.

Referenced by dGet(), pCopy(), and Restart().

doublereal RampDriveCaller::dSlope

private

Definition at line 576 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

doublereal RampDriveCaller::dStartTime

private

Definition at line 577 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

---

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

• drive_.h
• drive_.cc