OpenLexocad  27.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Base::SequencerBase Class Reference

#include <Sequencer.h>

Public Member Functions

virtual bool startbusy (const std::string &caption, const std::string &message, bool forceShow)
 
virtual bool startbusy (const Base::String &caption, const Base::String &message, bool forceShow)
 
virtual bool start (const std::string &caption, const std::string &message, int steps, int from, int to, bool)
 
virtual bool start (const Base::String &caption, const Base::String &message, int steps, int from, int to, bool)
 
virtual void stop ()
 
virtual void setStep (int step, bool canAbort=true)
 
virtual void setStepContinuous (int step, bool canAbort=true)
 
virtual void setMessage (const std::string &message)
 
virtual void setMessage (const Base::String &message)
 
virtual void setMinimumDuration (int milliseconds)
 
virtual int getMinimumDuration () const
 
virtual void busy1 ()
 
virtual void busy10 ()
 
virtual void busy100 ()
 
virtual void busy1000 ()
 
virtual void busy10000 ()
 
virtual Base::String getMessage ()
 
virtual void setHidden (bool hidden)
 
virtual void show (bool onoff)
 
void abort ()
 Throws Base::AbortException. More...
 
bool isRunning () const
 
int getCurrentStep () const
 
int getSteps () const
 
void setNextBlock (int from, int to)
 
void getNextBlock (int &from, int &to)
 
void setThisBlock (int from, int to)
 
int getFrom ()
 
int getTo ()
 
void setNoWindowModeInfoFlag (bool aValue)
 setters/getters for indiate if the Lexocad window mode is NO_WINDOW More...
 
bool getNoWindowModeInfoFlag ()
 
bool setWriteStepToStdout (bool aEnabled, std::string aOutputStepPrefixString)
 enable writing sequencer progress to std::cout, disabled automatically when stop method of this class is called More...
 

Static Public Member Functions

static SequencerBase & instance (void)
 
static void setInstance (SequencerBase *p)
 

Protected Member Functions

 SequencerBase ()
 
virtual ~SequencerBase ()
 

Protected Attributes

bool _isRunning
 
bool _canAbort
 
int _currentStep
 
int _steps
 
int _thisBlockFrom
 
int _thisBlockTo
 
int _nextBlockFrom
 
int _nextBlockTo
 
int _minimumDuration
 
Base::String _message
 
bool _windowModeActiveFlag
 
bool _writeStepToStdout
 
std::string _writeStepToStdcoutPrefixString
 

Constructor & Destructor Documentation

◆ SequencerBase()

Base::SequencerBase::SequencerBase ( )
protected

◆ ~SequencerBase()

virtual Base::SequencerBase::~SequencerBase ( )
protectedvirtual

Member Function Documentation

◆ abort()

void Base::SequencerBase::abort ( )

Throws Base::AbortException.

◆ busy1()

virtual void Base::SequencerBase::busy1 ( )
virtual

◆ busy10()

virtual void Base::SequencerBase::busy10 ( )
virtual

◆ busy100()

virtual void Base::SequencerBase::busy100 ( )
virtual

◆ busy1000()

virtual void Base::SequencerBase::busy1000 ( )
virtual

◆ busy10000()

virtual void Base::SequencerBase::busy10000 ( )
virtual

◆ getCurrentStep()

int Base::SequencerBase::getCurrentStep ( ) const

◆ getFrom()

int Base::SequencerBase::getFrom ( )

◆ getMessage()

virtual Base::String Base::SequencerBase::getMessage ( )
virtual

◆ getMinimumDuration()

virtual int Base::SequencerBase::getMinimumDuration ( ) const
virtual

◆ getNextBlock()

void Base::SequencerBase::getNextBlock ( int &  from,
int &  to 
)

◆ getNoWindowModeInfoFlag()

bool Base::SequencerBase::getNoWindowModeInfoFlag ( )

◆ getSteps()

int Base::SequencerBase::getSteps ( ) const

◆ getTo()

int Base::SequencerBase::getTo ( )

◆ instance()

static SequencerBase& Base::SequencerBase::instance ( void  )
static

◆ isRunning()

bool Base::SequencerBase::isRunning ( ) const

◆ setHidden()

virtual void Base::SequencerBase::setHidden ( bool  hidden)
virtual

◆ setInstance()

static void Base::SequencerBase::setInstance ( SequencerBase *  p)
static

◆ setMessage() [1/2]

virtual void Base::SequencerBase::setMessage ( const std::string &  message)
virtual

◆ setMessage() [2/2]

virtual void Base::SequencerBase::setMessage ( const Base::String &  message)
virtual

◆ setMinimumDuration()

virtual void Base::SequencerBase::setMinimumDuration ( int  milliseconds)
virtual

◆ setNextBlock()

void Base::SequencerBase::setNextBlock ( int  from,
int  to 
)

◆ setNoWindowModeInfoFlag()

void Base::SequencerBase::setNoWindowModeInfoFlag ( bool  aValue)

setters/getters for indiate if the Lexocad window mode is NO_WINDOW

◆ setStep()

virtual void Base::SequencerBase::setStep ( int  step,
bool  canAbort = true 
)
virtual

◆ setStepContinuous()

virtual void Base::SequencerBase::setStepContinuous ( int  step,
bool  canAbort = true 
)
virtual

◆ setThisBlock()

void Base::SequencerBase::setThisBlock ( int  from,
int  to 
)

◆ setWriteStepToStdout()

bool Base::SequencerBase::setWriteStepToStdout ( bool  aEnabled,
std::string  aOutputStepPrefixString 
)

enable writing sequencer progress to std::cout, disabled automatically when stop method of this class is called

◆ show()

virtual void Base::SequencerBase::show ( bool  onoff)
virtual

◆ start() [1/2]

virtual bool Base::SequencerBase::start ( const std::string &  caption,
const std::string &  message,
int  steps,
int  from,
int  to,
bool   
)
virtual

◆ start() [2/2]

virtual bool Base::SequencerBase::start ( const Base::String &  caption,
const Base::String &  message,
int  steps,
int  from,
int  to,
bool   
)
virtual

◆ startbusy() [1/2]

virtual bool Base::SequencerBase::startbusy ( const std::string &  caption,
const std::string &  message,
bool  forceShow 
)
virtual

◆ startbusy() [2/2]

virtual bool Base::SequencerBase::startbusy ( const Base::String &  caption,
const Base::String &  message,
bool  forceShow 
)
virtual

◆ stop()

virtual void Base::SequencerBase::stop ( )
virtual

Member Data Documentation

◆ _canAbort

bool Base::SequencerBase::_canAbort
protected

◆ _currentStep

int Base::SequencerBase::_currentStep
protected

◆ _isRunning

bool Base::SequencerBase::_isRunning
protected

◆ _message

Base::String Base::SequencerBase::_message
protected

◆ _minimumDuration

int Base::SequencerBase::_minimumDuration
protected

◆ _nextBlockFrom

int Base::SequencerBase::_nextBlockFrom
protected

◆ _nextBlockTo

int Base::SequencerBase::_nextBlockTo
protected

◆ _steps

int Base::SequencerBase::_steps
protected

◆ _thisBlockFrom

int Base::SequencerBase::_thisBlockFrom
protected

◆ _thisBlockTo

int Base::SequencerBase::_thisBlockTo
protected

◆ _windowModeActiveFlag

bool Base::SequencerBase::_windowModeActiveFlag
protected

◆ _writeStepToStdcoutPrefixString

std::string Base::SequencerBase::_writeStepToStdcoutPrefixString
protected

◆ _writeStepToStdout

bool Base::SequencerBase::_writeStepToStdout
protected
The documentation for this class was generated from the following file: