SwitchDriveCaller Class Reference

Inheritance diagram for SwitchDriveCaller:

Collaboration diagram for SwitchDriveCaller:

Public Types
enum	Type { SDC_FLOOR, SDC_CEIL, SDC_NEAREST }
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 }

Public Member Functions
	SwitchDriveCaller (const DriveHandler *pDH, const DriveOwner &oSwitch, Type eType, const std::vector< DriveOwner > &drives)
virtual	~SwitchDriveCaller ()
bool	bIsDifferentiable (void) const
virtual std::ostream &	Restart (std::ostream &out) const
doublereal	dGet (const doublereal &dVar) const
virtual doublereal	dGetP (const doublereal &dVar) const
DriveCaller *	pCopy (void) 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 Types
typedef std::vector < DriveOwner >::const_iterator	iterator

Private Member Functions
const DriveCaller *	pGetDrive () const

Private Attributes
DriveOwner	oSwitch
Type	eType
const std::vector< DriveOwner >	rgDrives

Additional Inherited Members
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 56 of file module-switch_drive.cc.

Member Typedef Documentation

typedef std::vector<DriveOwner>::const_iterator SwitchDriveCaller::iterator

private

Definition at line 81 of file module-switch_drive.cc.

Member Enumeration Documentation

enum SwitchDriveCaller::Type

Enumerator
SDC_FLOOR
SDC_CEIL
SDC_NEAREST

Definition at line 59 of file module-switch_drive.cc.

        {
                SDC_FLOOR,
                SDC_CEIL,
                SDC_NEAREST
        };

Constructor & Destructor Documentation

SwitchDriveCaller::SwitchDriveCaller ( const DriveHandler *  pDH, const DriveOwner &  oSwitch, Type  eType, const std::vector< DriveOwner > &  drives  )

explicit

Definition at line 90 of file module-switch_drive.cc.

References NO_OP.

Referenced by pCopy().

: DriveCaller(pDH),
  oSwitch(oSwitch),
  eType(eType),
  rgDrives(drives)
{
        NO_OP;
}

SwitchDriveCaller::~SwitchDriveCaller ( )

virtual

Definition at line 102 of file module-switch_drive.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

bool SwitchDriveCaller::bIsDifferentiable ( void  ) const

virtual

Reimplemented from DriveCaller.

Definition at line 157 of file module-switch_drive.cc.

References rgDrives.

{
        for (iterator i = rgDrives.begin(); i != rgDrives.end(); ++i) {
                if (!i->bIsDifferentiable()) {
                        return false;
                }
        }

        return true;
}

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

virtual

Implements DriveCaller.

Definition at line 147 of file module-switch_drive.cc.

References DriveCaller::dGet(), and pGetDrive().

{
        return pGetDrive()->dGet(dVar);
}

Here is the call graph for this function:

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

virtual

Reimplemented from DriveCaller.

Definition at line 152 of file module-switch_drive.cc.

References DriveCaller::dGetP(), and pGetDrive().

{
        return pGetDrive()->dGetP(dVar);
}

Here is the call graph for this function:

DriveCaller * SwitchDriveCaller::pCopy ( void  ) const

virtual

Implements DriveCaller.

Definition at line 188 of file module-switch_drive.cc.

References eType, oSwitch, DriveCaller::pGetDrvHdl(), rgDrives, SAFENEWWITHCONSTRUCTOR, and SwitchDriveCaller().

{
        DriveCaller* pDC = 0;

        SAFENEWWITHCONSTRUCTOR(pDC,
                        SwitchDriveCaller,
                        SwitchDriveCaller(pGetDrvHdl(), oSwitch, eType, rgDrives));

        return pDC;
}

Here is the call graph for this function:

const DriveCaller * SwitchDriveCaller::pGetDrive ( ) const

private

Definition at line 107 of file module-switch_drive.cc.

References ASSERT, DriveOwner::dGet(), eType, WithLabel::GetLabel(), MBDYN_EXCEPT_ARGS, oSwitch, DriveOwner::pGetDriveCaller(), rgDrives, SDC_CEIL, SDC_FLOOR, and SDC_NEAREST.

Referenced by dGet(), and dGetP().

{
    const doublereal dSwitch = oSwitch.dGet();

        integer iDrive;

        switch (eType) {
        case SDC_FLOOR:
                iDrive = floor(dSwitch);
                break;

        case SDC_CEIL:
                iDrive = ceil(dSwitch);
                break;

        case SDC_NEAREST:
                iDrive = round(dSwitch);
                break;

        default:
                ASSERT(false);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        const integer iMaxIndex = rgDrives.size() - 1;

        if (iDrive < 0 || iDrive > iMaxIndex) {
                silent_cerr("drive caller(" << GetLabel()
                                << "): argument " << iDrive
                << " from drive caller " << oSwitch.pGetDriveCaller()->GetLabel()
                                << " is not in range [0:" << iMaxIndex << "]"
                                << std::endl);

                throw ErrIndexOutOfRange(iDrive, 0, iMaxIndex, MBDYN_EXCEPT_ARGS);
        }

        return rgDrives[iDrive].pGetDriveCaller();
}

Here is the call graph for this function:

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

virtual

Implements DriveCaller.

Definition at line 170 of file module-switch_drive.cc.

References eType, rgDrives, and SDC_FLOOR.

{
        out << "switch, " << (eType == SDC_FLOOR ? "floor, " : "ceil, ")
                << rgDrives.size() << ", ";

        for (iterator i = rgDrives.begin(); i != rgDrives.end(); ++i) {
                i->pGetDriveCaller()->Restart(out);

                if (rgDrives.end() - i > 1) {
                        out << ", ";
                }
        }

        return out;
}

Member Data Documentation

Type SwitchDriveCaller::eType

private

Definition at line 80 of file module-switch_drive.cc.

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

DriveOwner SwitchDriveCaller::oSwitch

private

Definition at line 79 of file module-switch_drive.cc.

Referenced by pCopy(), and pGetDrive().

const std::vector<DriveOwner> SwitchDriveCaller::rgDrives

private

Definition at line 82 of file module-switch_drive.cc.

Referenced by bIsDifferentiable(), pCopy(), pGetDrive(), and Restart().

---

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

• module-switch_drive.cc