RTSolverBase Class Reference

#include <rtsolver.h>

Inheritance diagram for RTSolverBase:

Collaboration diagram for RTSolverBase:

Public Types
enum	RTMode {   MBRT_UNKNOWN = -1, MBRT_WAITPERIOD, MBRT_SEMAPHORE, MBRT_IO,   MBRT_LASTMODE }

Public Member Functions
	RTSolverBase (Solver *pS, RTMode eRTMode, unsigned long lRTPeriod, unsigned long RTStackSize, bool bRTAllowNonRoot, int RTCpuMap, bool bNoOutput=true)
virtual	~RTSolverBase (void)
virtual std::ostream &	Restart (std::ostream &out) const =0
virtual void	Setup (void)=0
virtual void	Init (void)
virtual bool	IsStopCommanded (void)
virtual void	StopCommanded (void)=0
virtual void	Log (void)=0
virtual void	Wait (void)=0

Protected Member Functions
bool	RTWaitPeriod (void) const
bool	RTSemWait (void) const
bool	RTBlockingIO (void) const

Protected Attributes
Solver *	pS
RTMode	eRTMode
unsigned long	lRTPeriod
unsigned long	RTStackSize
bool	bRTAllowNonRoot
int	RTCpuMap
bool	bNoOutput
volatile int	RTSteps

Detailed Description

Definition at line 39 of file rtsolver.h.

Member Enumeration Documentation

enum RTSolverBase::RTMode

Enumerator
MBRT_UNKNOWN
MBRT_WAITPERIOD
MBRT_SEMAPHORE
MBRT_IO
MBRT_LASTMODE

Definition at line 41 of file rtsolver.h.

                    {
                MBRT_UNKNOWN = -1,

                MBRT_WAITPERIOD,
                MBRT_SEMAPHORE,
                MBRT_IO,

                MBRT_LASTMODE
        };

Constructor & Destructor Documentation

RTSolverBase::RTSolverBase	(	Solver *	pS,
		RTMode	eRTMode,
		unsigned long	lRTPeriod,
		unsigned long	RTStackSize,
		bool	bRTAllowNonRoot,
		int	RTCpuMap,
		bool	bNoOutput = true
	)

Definition at line 44 of file rtsolver.cc.

References ASSERT.

: pS(pS),
eRTMode(eRTMode),
lRTPeriod(lRTPeriod),
RTStackSize(RTStackSize),
bRTAllowNonRoot(bRTAllowNonRoot),
RTCpuMap(RTCpuMap),
bNoOutput(bNoOutput)
{
        ASSERT(RTStackSize > 0);
        ASSERT(lRTPeriod > 0);
}

RTSolverBase::~RTSolverBase ( void  )

virtual

Definition at line 63 of file rtsolver.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

void RTSolverBase::Init ( void  )

virtual

Reimplemented in RTAISolver.

Definition at line 69 of file rtsolver.cc.

References bNoOutput, mbdyn_reserve_stack(), pS, RTStackSize, and SolverDiagnostics::SetNoOutput().

Referenced by RTAISolver::Init(), InverseSolver::Prepare(), and Solver::Start().

{
        /* if using real-time, clear out any type of output */
        if (bNoOutput) {
                pS->SetNoOutput();
        }

        mbdyn_reserve_stack(RTStackSize);
}

Here is the call graph for this function:

bool RTSolverBase::IsStopCommanded ( void  )

virtual

Reimplemented in RTAISolver.

Definition at line 81 of file rtsolver.cc.

Referenced by InverseSolver::Advance(), and Solver::Advance().

{
        return false;
}

virtual void RTSolverBase::Log ( void  )

pure virtual

Implemented in RTAISolver.

Referenced by InverseSolver::Advance(), and Solver::Advance().

virtual std::ostream& RTSolverBase::Restart ( std::ostream &  out ) const

pure virtual

Implemented in RTAISolver.

bool RTSolverBase::RTBlockingIO ( void  ) const

inlineprotected

Definition at line 73 of file rtsolver.h.

References eRTMode, and MBRT_IO.

                                      {
                return (eRTMode == MBRT_IO);
        };

bool RTSolverBase::RTSemWait ( void  ) const

inlineprotected

Definition at line 69 of file rtsolver.h.

References eRTMode, and MBRT_SEMAPHORE.

Referenced by RTAISolver::Init(), and RTAISolver::Wait().

                                   {
                return (eRTMode == MBRT_SEMAPHORE);
        };

bool RTSolverBase::RTWaitPeriod ( void  ) const

inlineprotected

Definition at line 65 of file rtsolver.h.

References eRTMode, and MBRT_WAITPERIOD.

Referenced by RTAISolver::Init(), and RTAISolver::Wait().

                                      {
                return (eRTMode == MBRT_WAITPERIOD);
        };

virtual void RTSolverBase::Setup ( void  )

pure virtual

Implemented in RTAISolver.

Referenced by InverseSolver::Prepare(), and Solver::Prepare().

virtual void RTSolverBase::StopCommanded ( void  )

pure virtual

Implemented in RTAISolver.

Referenced by InverseSolver::Advance(), and Solver::Advance().

virtual void RTSolverBase::Wait ( void  )

pure virtual

Implemented in RTAISolver.

Referenced by InverseSolver::Advance(), and Solver::Advance().

Member Data Documentation

bool RTSolverBase::bNoOutput

protected

Definition at line 63 of file rtsolver.h.

Referenced by Init().

bool RTSolverBase::bRTAllowNonRoot

protected

Definition at line 60 of file rtsolver.h.

Referenced by RTAISolver::Init(), RTAISolver::Restart(), and RTAISolver::Setup().

RTMode RTSolverBase::eRTMode

protected

Definition at line 54 of file rtsolver.h.

Referenced by RTAISolver::Restart(), RTBlockingIO(), RTSemWait(), and RTWaitPeriod().

unsigned long RTSolverBase::lRTPeriod

protected

Definition at line 57 of file rtsolver.h.

Solver* RTSolverBase::pS

protected

Definition at line 52 of file rtsolver.h.

Referenced by Init().

int RTSolverBase::RTCpuMap

protected

Definition at line 61 of file rtsolver.h.

Referenced by RTAISolver::Init(), RTAISolver::Restart(), and RTAISolver::Setup().

unsigned long RTSolverBase::RTStackSize

protected

Definition at line 59 of file rtsolver.h.

Referenced by Init(), and RTAISolver::Restart().

volatile int RTSolverBase::RTSteps

protected

Definition at line 75 of file rtsolver.h.

Referenced by RTAISolver::Wait().

---

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

• rtsolver.h
• rtsolver.cc