kome::core::DisplayProgress Class Reference

showing progress with display class More...

#include <DisplayProgress.h>

Inheritance diagram for kome::core::DisplayProgress:

Collaboration diagram for kome::core::DisplayProgress:

Public Member Functions
	DisplayProgress (const char *title)
	constructor More...
virtual	~DisplayProgress ()
	destructor
Public Member Functions inherited from kome::core::Progress
	Progress (const char *title=NULL)
	constructor More...
virtual	~Progress ()
	destructor
void	setRange (const int start, const int end)
	sets progress range More...
void	setPosition (const int pos, const bool bForced=false)
	sets progress position More...
void	setStatus (const char *status, const bool bForced=false)
	sets status More...
bool	isStopped ()
	judges whether it has to finish More...
void	fill ()
	sets end position
int	getRelativePosition ()
	gets relative position More...
Timer *	createTimer (const char *name)
	creates timer More...
unsigned int	getNumberOfTimers ()
	gets the number of timers More...
const char *	getTimerName (const unsigned int index)
	gets timer name More...
Timer *	getTimer (const unsigned int index)
	gets timer More...
void	createSubProgresses (const unsigned int num)
	creates sub progresses More...
unsigned int	getNumberOfSubProgresses ()
	gets the number of sub progresses More...
Progress *	getSubProgress (const unsigned int idx)
	gets subprogress More...

Protected Member Functions
virtual void	onSetRange (const int start, const int end)
	This method is called by setRange method. (override method) More...
virtual void	onSetPosition (const int pos, const int prevPos)
	This method is called by setPosition method. (override method) More...
virtual void	onSetStatus (const char *status, const bool bForced=false)
	This method is called by setStatus method. (override method) More...
virtual bool	onIsStopped ()
	This method is called by isStopped method. (override method) More...
virtual void	onFill (void)
	This method is called by fill method. (override method)

Protected Attributes
boost::progress_display *	m_progress
Protected Attributes inherited from kome::core::Progress
std::vector< Progress * >	m_subProgresses
int	m_start
int	m_end
int	m_pos
int	m_prevPos
int	m_relPos
std::string	m_title
Timer	m_timer
std::vector< std::pair < std::string, Timer * > > *	m_timers
long long	m_llPrevTime
std::string	m_strStatus

Additional Inherited Members
Static Public Member Functions inherited from kome::core::Progress
static Progress &	getIgnoringProgress ()
	gets progress object. But this object does nothing even if a method is called. More...

Detailed Description

showing progress with display class

Definition at line 28 of file DisplayProgress.h.

Constructor & Destructor Documentation

kome::core::DisplayProgress::DisplayProgress

(

const char *

title

)

constructor

Parameters

[in]

title

progress title

Definition at line 27 of file DisplayProgress.cpp.

                                                    : Progress( title ) {
    m_progress = NULL;
}

Member Function Documentation

bool kome::core::DisplayProgress::onIsStopped ( )

protectedvirtual

This method is called by isStopped method. (override method)

Returns

If it has to finish, this method returns true

Implements kome::core::Progress.

Definition at line 73 of file DisplayProgress.cpp.

                                  {
    return false;
}

void kome::core::DisplayProgress::onSetPosition ( const int  pos, const int  prevPos  )

protectedvirtual

This method is called by setPosition method. (override method)

Parameters

[in]	pos	progress position
[in]	prevPos	previous position

Implements kome::core::Progress.

Definition at line 52 of file DisplayProgress.cpp.

                                                                      {
    // check the member
    if( m_progress == NULL ) {
        return;
    }

    // add count
    int count = pos - prevPos;
    if( m_start > m_end ) {
        count = - count;
    }
    if( count > 0 ) {
        ( *m_progress ) += count;
    }
}

void kome::core::DisplayProgress::onSetRange ( const int  start, const int  end  )

protectedvirtual

This method is called by setRange method. (override method)

Parameters

[in]	start	start position
[in]	end	end position

Implements kome::core::Progress.

Definition at line 39 of file DisplayProgress.cpp.

                                                                 {
    // range
    int range = end - start;
    range = ABS( range );

    // create object
    if( m_progress != NULL ) {
        delete m_progress;
    }
    m_progress = new boost::progress_display( range );
}

void kome::core::DisplayProgress::onSetStatus ( const char *  status, const bool  bForced = false  )

protectedvirtual

This method is called by setStatus method. (override method)

Parameters

[in]	status	status
[in]	bForced	flag for drawing forced

Implements kome::core::Progress.

Definition at line 69 of file DisplayProgress.cpp.

                                                                          {
}

Member Data Documentation

boost::progress_display* kome::core::DisplayProgress::m_progress

protected

progress

Definition at line 45 of file DisplayProgress.h.

---

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

• CoreToolkits/DisplayProgress.h
• CoreToolkits/DisplayProgress.cpp