OpenLexocad  28.0
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)
 
virtual void move ()
 
void abort ()
 Throws Base::AbortException. More...
 
bool isRunning () const
 
void setRunning (bool b)
 
int getCurrentStep () const
 
void setCurrentStep (int s)
 
int getSteps () const
 
void setSteps (int steps)
 
void setNextBlock (int from, int to)
 
void getNextBlock (int &from, int &to)
 
void setThisBlock (int from, int to)
 
int getFrom ()
 
int getTo ()
 
bool canAbort () const
 
void setCanAbort (bool p)
 
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...
 
bool isWriteStepToStdout () const
 
std::string getWriteStepToStdcoutPrefixString () const
 
virtual void pushState ()
 
virtual void popState ()
 

Static Public Member Functions

static SequencerBaseinstance (void)
 
static void setInstance (SequencerBase *p)
 
static void setFactory (std::function< Base::SequencerBase *()> func)
 
static Base::SequencerBasecreate ()
 

Protected Member Functions

 SequencerBase ()
 
virtual ~SequencerBase ()
 

Constructor & Destructor Documentation

◆ SequencerBase()

Base::SequencerBase::SequencerBase ( )
protected

◆ ~SequencerBase()

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

Member Function Documentation

◆ abort()

void Base::SequencerBase::abort ( )

◆ 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

◆ canAbort()

bool Base::SequencerBase::canAbort ( ) const

◆ create()

static Base::SequencerBase* Base::SequencerBase::create ( )
static

◆ 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 ( )

◆ getWriteStepToStdcoutPrefixString()

std::string Base::SequencerBase::getWriteStepToStdcoutPrefixString ( ) const

◆ instance()

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

◆ isRunning()

bool Base::SequencerBase::isRunning ( ) const

◆ isWriteStepToStdout()

bool Base::SequencerBase::isWriteStepToStdout ( ) const

◆ move()

virtual void Base::SequencerBase::move ( )
inlinevirtual

◆ popState()

virtual void Base::SequencerBase::popState ( )
virtual

◆ pushState()

virtual void Base::SequencerBase::pushState ( )
virtual

◆ setCanAbort()

void Base::SequencerBase::setCanAbort ( bool  p)

◆ setCurrentStep()

void Base::SequencerBase::setCurrentStep ( int  s)

◆ setFactory()

static void Base::SequencerBase::setFactory ( std::function< Base::SequencerBase *()>  func)
static

◆ 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 Base::String message)
virtual

◆ setMessage() [2/2]

virtual void Base::SequencerBase::setMessage ( const std::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

◆ setRunning()

void Base::SequencerBase::setRunning ( bool  b)

◆ setStep()

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

◆ setStepContinuous()

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

◆ setSteps()

void Base::SequencerBase::setSteps ( int  steps)

◆ 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 Base::String caption,
const Base::String message,
int  steps,
int  from,
int  to,
bool   
)
virtual

◆ start() [2/2]

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

◆ startbusy() [1/2]

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

◆ startbusy() [2/2]

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

◆ stop()

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

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