kome::core::Progress Class Reference

progress display abstract class More...

#include <Progress.h>

Inheritance diagram for kome::core::Progress:

Collaboration diagram for kome::core::Progress:

Public Member Functions
	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...

Static Public Member Functions
static Progress &	getIgnoringProgress ()
	gets progress object. But this object does nothing even if a method is called. More...

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

Protected Attributes
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

Detailed Description

progress display abstract class

Definition at line 31 of file Progress.h.

Constructor & Destructor Documentation

kome::core::Progress::Progress

(

const char *

title = NULL

)

constructor

Parameters

[in]

title

progress title

Definition at line 37 of file Progress.cpp.

                                      {
    m_start = 0;
    m_end = 0;
    m_pos = 0;
    m_prevPos = 0;
    m_relPos = 0;
    m_title = NVL( title, "" );

// >>>>>>   @Date:2013/11/18    <Add>   A.Ozaki
//
    m_llPrevTime = 0;
    m_strStatus.clear( );
//
// <<<<<<   @Date:2013/11/18    <Add>   A.Ozaki

    m_timers = new std::vector< std::pair< std::string, Timer* > >();
}

Member Function Documentation

void kome::core::Progress::createSubProgresses

(

const unsigned int

num

)

creates sub progresses

Parameters

[in]

num

the number of subprogresses

Definition at line 299 of file Progress.cpp.

                                                           {
    // check the number
    if( num == 0 ) {
        return;
    }
    if( this == &( getIgnoringProgress() ) ) {
        return;
    }

    // create progresses
    m_subProgresses.reserve( num );
    for( unsigned int i = 0; i < num; i++ ) {
        Progress* subProgress = new SubProgress( *this );
        delete subProgress->m_timers;
        subProgress->m_timers = m_timers;

        m_subProgresses.push_back( subProgress );
    }

    // set range
    setRange( 0, (int)m_subProgresses.size() * 100 );
}

Here is the call graph for this function:

Timer * kome::core::Progress::createTimer

(

const char *

name

)

creates timer

Parameters

[in]

name

timer name

Returns

created timer

Definition at line 252 of file Progress.cpp.

                                               {
    // check the name
    if( name == NULL || m_timers == NULL ) {
        return NULL;
    }

    // search
    for( unsigned int i = 0; i < m_timers->size(); i++ ) {
        if( ( *m_timers )[ i ].first.compare( name ) == 0 ) {
            return ( *m_timers )[ i ].second;
        }
    }

    // new timer
    m_timers->push_back( std::make_pair( name, new Timer() ) );
    
    return m_timers->back().second;
}

static Progress & kome::core::Progress::getIgnoringProgress ( )

static

gets progress object. But this object does nothing even if a method is called.

Returns

progress object

Definition at line 343 of file Progress.cpp.

                                        {
    static IgnoringProgress progress;

    return progress;
}

unsigned int kome::core::Progress::getNumberOfSubProgresses

(

)

gets the number of sub progresses

Returns

the number of sub progresses

Definition at line 323 of file Progress.cpp.

                                                {
    if( this == &( getIgnoringProgress() ) ) {
        return 0;
    }
    return m_subProgresses.size();
}

Here is the call graph for this function:

unsigned int kome::core::Progress::getNumberOfTimers

(

)

gets the number of timers

Returns

the number of timers

Definition at line 272 of file Progress.cpp.

                                         {
    if( m_timers == NULL ) {
        return 0;
    }

    return m_timers->size();
}

int kome::core::Progress::getRelativePosition

(

)

gets relative position

Returns

relative position

Definition at line 247 of file Progress.cpp.

                                  {
    return m_relPos;
}

Progress * kome::core::Progress::getSubProgress

(

const unsigned int

idx

)

gets subprogress

Parameters

[in]

idx

sub progress index

Returns

sub progress object (If NULL, the index is illegal.)

Definition at line 331 of file Progress.cpp.

                                                           {
    if( this == &( getIgnoringProgress() ) ) {
        return this;
    }
    if( idx >= m_subProgresses.size() ) {
        return NULL;
    }

    return m_subProgresses[ idx ];
}

Here is the call graph for this function:

Timer * kome::core::Progress::getTimer

(

const unsigned int

index

)

gets timer

Parameters

[in]

index

timer index

Returns

timer object

Definition at line 290 of file Progress.cpp.

                                                    {
    if( m_timers == NULL || index >= m_timers->size() ) {
        return NULL;
    }

    return ( *m_timers )[ index ].second;
}

const char * kome::core::Progress::getTimerName

(

const unsigned int

index

)

gets timer name

Parameters

[in]

index

timer index

Returns

timer name (If NULL, the index is illegal.)

Definition at line 281 of file Progress.cpp.

                                                             {
    if( m_timers == NULL || index >= m_timers->size() ) {
        return NULL;
    }

    return ( *m_timers )[ index ].first.c_str();
}

bool kome::core::Progress::isStopped

(

)

judges whether it has to finish

Returns

If it has to finish, this method returns true

Definition at line 199 of file Progress.cpp.

                         {
    bool ret = onIsStopped();

    return ret;
}

Here is the call graph for this function:

bool kome::core::Progress::onIsStopped ( )

protectedpure virtual

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

Returns

If it has to finish, this method returns true

Implemented in kome::core::SubProgress, kome::core::IgnoringProgress, and kome::core::DisplayProgress.

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

protectedpure virtual

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

Parameters

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

Implemented in kome::core::SubProgress, kome::core::IgnoringProgress, and kome::core::DisplayProgress.

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

protectedpure virtual

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

Parameters

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

Implemented in kome::core::SubProgress, kome::core::IgnoringProgress, and kome::core::DisplayProgress.

void kome::core::Progress::onSetStatus ( const char *  status, const bool  bForced  )

protectedpure virtual

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

Parameters

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

Implemented in kome::core::SubProgress, kome::core::IgnoringProgress, and kome::core::DisplayProgress.

void kome::core::Progress::setPosition	(	const int	pos,
		const bool	bForced = false
	)

sets progress position

Parameters

[in]	pos	progress position
[in]	bForced	flag of drawing forced

Definition at line 98 of file Progress.cpp.

                                                              {
    
    // set members
    m_prevPos = m_pos;
    m_pos = pos;

// >>>>>>   @Date:2013/11/18    <Add>   A.Ozaki
//
#ifdef  _USE_INTERVAL_
    if  ( false == bForced )
    {
        long long   llPassed = getcurrenttime( );
        llPassed = llPassed - m_llPrevTime;
        if  ( DRAW_INTERVAL > llPassed )
        {
            return;
        }
    }
    m_llPrevTime = getcurrenttime( );
#endif
//
// <<<<<<   @Date:2013/11/18    <Add>   A.Ozaki


    if( m_start == m_end ) {
        m_relPos = 0;
    }
    else {
        double d1 = (double)abs( m_pos - m_start );
        double d2 = (double)abs( m_end - m_pos );
        m_relPos = roundnum( d1 * 100.0 / ( d1 + d2 ) );
    }

// >>>>>>   @Date:2013/11/18    <Add>   A.Ozaki
//
#ifndef _USE_INTERVAL_
    if( isStopped() ){ // @date 2013.09.26 <Mod> M.Izumi 
        return;
    }
    // set position
    onSetPosition( m_pos, m_prevPos );
#else
    if  ( false == m_strStatus.empty( ) )
    {
        onSetStatus( m_strStatus.c_str( ), bForced );
        m_strStatus.clear( );
    }

    // set position
    onSetPosition( m_pos, m_prevPos );
    
    if  ( isStopped( ) )
    {
        return;
    }
#endif
    return;
//
// <<<<<<   @Date:2013/11/18    <Add>   A.Ozaki
}

Here is the call graph for this function:

void kome::core::Progress::setRange	(	const int	start,
		const int	end
	)

sets progress range

Parameters

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

Definition at line 79 of file Progress.cpp.

                                                        {
    
    // set members
    m_start = start;
    m_end = end;

    // start timer
    m_timer.start();
        
    // set range
    onSetRange( start, end );   
    setPosition( start );
    
    if( isStopped() ){ // @date 2013.09.26 <Mod> M.Izumi 
        return;
    }   
}

Here is the call graph for this function:

void kome::core::Progress::setStatus	(	const char *	status,
		const bool	bForced = false
	)

sets status

Parameters

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

Definition at line 160 of file Progress.cpp.

                                                                 {
// >>>>>>   @Date:2013/11/18    <Add>   A.Ozaki
//
#ifndef _USE_INTERVAL_
    if( isStopped() ){ // @date 2013.09.26 <Mod> M.Izumi 
        return;
    }
    onSetStatus( status );
#else
    if  ( (const char *)NULL == status )
    {
        if  ( false == m_strStatus.empty( ) )
        {
            onSetStatus( m_strStatus.c_str( ), bForced );
        }
    }
    else
    {
        if  ( false == bForced )
        {
            m_strStatus = NVL( status, "" );
        }
        else
        {
            onSetStatus( status, bForced );
        }

        if  ( isStopped( ) )
        {
            return;
        }
    }
#endif
    return;
//
// <<<<<<   @Date:2013/11/18    <Add>   A.Ozaki
}

Here is the call graph for this function:

Member Data Documentation

int kome::core::Progress::m_end

protected

end position

Definition at line 53 of file Progress.h.

long long kome::core::Progress::m_llPrevTime

protected

previous update time

Definition at line 112 of file Progress.h.

int kome::core::Progress::m_pos

protected

current position

Definition at line 55 of file Progress.h.

int kome::core::Progress::m_prevPos

protected

previous position

Definition at line 57 of file Progress.h.

int kome::core::Progress::m_relPos

protected

relative position

Definition at line 59 of file Progress.h.

int kome::core::Progress::m_start

protected

start position

Definition at line 51 of file Progress.h.

std::string kome::core::Progress::m_strStatus

protected

status message

Definition at line 115 of file Progress.h.

std::vector< Progress* > kome::core::Progress::m_subProgresses

protected

sub progresses

Definition at line 48 of file Progress.h.

Timer kome::core::Progress::m_timer

protected

main timer

Definition at line 65 of file Progress.h.

std::vector< std::pair< std::string, Timer* > >* kome::core::Progress::m_timers

protected

timer array

Definition at line 68 of file Progress.h.

std::string kome::core::Progress::m_title

protected

title

Definition at line 62 of file Progress.h.

---

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

• CoreToolkits/Progress.h
• CoreToolkits/Progress.cpp