MeterDriveCaller Class Reference

#include <drive_.h>

Inheritance diagram for MeterDriveCaller:

Collaboration diagram for MeterDriveCaller:

Public Member Functions
	MeterDriveCaller (const DriveHandler *pDH, doublereal dS, doublereal dE, integer iS)
virtual	~MeterDriveCaller (void)
virtual DriveCaller *	pCopy (void) const
virtual std::ostream &	Restart (std::ostream &out) const
doublereal	dGet (const doublereal &dVar) const
integer	iGetSteps (void) const
Public Member Functions inherited from DriveCaller
	DriveCaller (const DriveHandler *pDH)
virtual	~DriveCaller (void)
virtual doublereal	dGet (void) const
virtual bool	bIsDifferentiable (void) const
virtual doublereal	dGetP (const doublereal &dVar) 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	dStartTime
doublereal	dEndTime
integer	iSteps
integer	iMeterDriveNumber

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 1268 of file drive_.h.

Constructor & Destructor Documentation

MeterDriveCaller::MeterDriveCaller	(	const DriveHandler *	pDH,
		doublereal	dS,
		doublereal	dE,
		integer	iS
	)

Definition at line 942 of file drive_.cc.

References iMeterDriveNumber, DriveHandler::iMeterInit(), iSteps, and DriveCaller::pDrvHdl.

Referenced by pCopy().

: DriveCaller(pDH),
dStartTime(dS),
dEndTime(dE),
iSteps(iS)
{
        iMeterDriveNumber = pDrvHdl->iMeterInit(iSteps);
}

Here is the call graph for this function:

MeterDriveCaller::~MeterDriveCaller ( void  )

virtual

Definition at line 952 of file drive_.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

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

inlinevirtual

Implements DriveCaller.

Definition at line 1295 of file drive_.h.

References DriveHandler::bGetMeter(), dEndTime, iMeterDriveNumber, and DriveCaller::pDrvHdl.

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

        return doublereal(pDrvHdl->bGetMeter(iMeterDriveNumber));
}

Here is the call graph for this function:

integer MeterDriveCaller::iGetSteps ( void  ) const

inline

Definition at line 1305 of file drive_.h.

References iSteps.

Referenced by DataManager::ReadControl().

{
        return iSteps;
}

DriveCaller * MeterDriveCaller::pCopy ( void  ) const

virtual

Implements DriveCaller.

Definition at line 959 of file drive_.cc.

References dEndTime, dStartTime, iSteps, MeterDriveCaller(), DriveCaller::pDrvHdl, and SAFENEWWITHCONSTRUCTOR.

{
        DriveCaller* pDC = 0;
        SAFENEWWITHCONSTRUCTOR(pDC,
                MeterDriveCaller,
                MeterDriveCaller(pDrvHdl, dStartTime, dEndTime, iSteps));
        return pDC;
}

Here is the call graph for this function:

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

virtual

Implements DriveCaller.

Definition at line 970 of file drive_.cc.

References dEndTime, dStartTime, and iSteps.

{
        out
                << " meter, " << dStartTime
                << ", " << dEndTime;
        if (iSteps > 1) {
                out << ", steps, " << iSteps;
        }
        return out;
}

Member Data Documentation

doublereal MeterDriveCaller::dEndTime

private

Definition at line 1271 of file drive_.h.

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

doublereal MeterDriveCaller::dStartTime

private

Definition at line 1270 of file drive_.h.

Referenced by pCopy(), and Restart().

integer MeterDriveCaller::iMeterDriveNumber

private

Definition at line 1273 of file drive_.h.

Referenced by dGet(), and MeterDriveCaller().

integer MeterDriveCaller::iSteps

private

Definition at line 1272 of file drive_.h.

Referenced by iGetSteps(), MeterDriveCaller(), pCopy(), and Restart().

---

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

• drive_.h
• drive_.cc