ARB
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ArbProgress::nestable Class Referenceabstract

#include <arb_progress.h>

Inheritance diagram for ArbProgress::nestable:
Inheritance graph
[legend]
Collaboration diagram for ArbProgress::nestable:
Collaboration graph
[legend]

Public Member Functions

virtual ~nestable ()
 
bool this_or_recent_is_weighted () const
 
bool aborted () const
 
virtual void set_text (int level, const char *text)=0
 
virtual void update_gauge (double gauge)=0
 
virtual void dump () const
 
void child_sets_text (int level, const char *text)
 
void allow_title_reuse ()
 
void update_parent_gauge (double gauge)
 
void child_terminated ()
 
void initial_update ()
 
void force_update ()
 
void inc ()
 
void inc_by (SINT count)
 
void inc_to (SINT x)
 
void inc_to_avoid_overflow (SINT x)
 
void done ()
 
void auto_subtitles (const char *prefix)
 
bool owns (const counter *pwnd) const
 
bool is_correct_owner () const
 

Static Public Member Functions

static SmartPtr< nestable > create (const char *title, SINT overall_count, const double *phase1_fraction)
 
static SmartPtr< nestable > create_suppressor ()
 
static bool have_weighted_progress ()
 
static void show_comment (const char *comment)
 

Protected Member Functions

virtual SmartPtr< nestable > create_child_progress (const char *title, SINT overall_count, const weightable &speed_)=0
 
 nestable (counter *counter_, bool has_title_, const weightable &speed_)
 

Protected Attributes

char * name
 
bool has_title
 
counter * cntr
 
weightable speed
 

Static Protected Attributes

static nestable * recent = NULp
 
static arb_status_implementation * impl = NULp
 

Detailed Description

Definition at line 119 of file arb_progress.h.

Constructor & Destructor Documentation

ArbProgress::nestable::nestable ( counter *  counter_,
bool  has_title_,
const weightable &  speed_ 
)
inlineprotected

Definition at line 140 of file arb_progress.h.

References arb_assert, is_correct_owner(), NULp, and recent.

virtual ArbProgress::nestable::~nestable ( )
inlinevirtual

Definition at line 163 of file arb_progress.h.

References arb_assert, and cntr.

Member Function Documentation

virtual SmartPtr<nestable> ArbProgress::nestable::create_child_progress ( const char *  title,
SINT  overall_count,
const weightable &  speed_ 
)
protectedpure virtual

Referenced by create().

SmartPtr< nestable > nestable::create ( const char *  title,
SINT  overall_count,
const double *  phase1_fraction 
)
static

Definition at line 357 of file arb_progress.cxx.

References active_arb_handlers, arb_assert, create_child_progress(), impl, implicated, ArbProgress::weightable::is_weighted(), recent, and arb_handlers::status.

SmartPtr< nestable > nestable::create_suppressor ( )
static

Definition at line 368 of file arb_progress.cxx.

static bool ArbProgress::nestable::have_weighted_progress ( )
static
bool ArbProgress::nestable::this_or_recent_is_weighted ( ) const
inline

Definition at line 179 of file arb_progress.h.

References ArbProgress::weightable::is_weighted(), and this_or_recent_is_weighted().

Referenced by this_or_recent_is_weighted().

bool nestable::aborted ( ) const

Definition at line 378 of file arb_progress.cxx.

References impl, and arb_status_implementation::user_abort.

Referenced by arb_progress::aborted().

virtual void ArbProgress::nestable::set_text ( int  level,
const char *  text 
)
pure virtual

Implemented in null_progress, and initial_progress.

Referenced by child_sets_text(), show_comment(), and arb_progress::subtitle().

virtual void ArbProgress::nestable::update_gauge ( double  gauge)
pure virtual

Implemented in null_progress, and initial_progress.

virtual void ArbProgress::nestable::dump ( ) const
virtual
void ArbProgress::nestable::child_sets_text ( int  level,
const char *  text 
)
inline

Definition at line 192 of file arb_progress.h.

References ArbProgress::counter::has_auto_subtitles(), and set_text().

void ArbProgress::nestable::allow_title_reuse ( )
inline

Definition at line 195 of file arb_progress.h.

Referenced by arb_progress::allow_title_reuse().

void ArbProgress::nestable::update_parent_gauge ( double  gauge)
inline

Definition at line 197 of file arb_progress.h.

References ArbProgress::counter::child_updates_gauge().

void ArbProgress::nestable::child_terminated ( )
inline

Definition at line 198 of file arb_progress.h.

References ArbProgress::counter::implicit_inc().

Referenced by arb_progress::sub_progress_skipped().

void ArbProgress::nestable::initial_update ( )
inline

Definition at line 200 of file arb_progress.h.

References ArbProgress::counter::force_update().

void ArbProgress::nestable::force_update ( )
inline

Definition at line 201 of file arb_progress.h.

References ArbProgress::counter::force_update().

Referenced by arb_progress::force_update().

void ArbProgress::nestable::inc ( )
inline

Definition at line 203 of file arb_progress.h.

References ArbProgress::counter::inc().

Referenced by arb_progress::inc().

void ArbProgress::nestable::inc_by ( SINT  count)
inline

Definition at line 204 of file arb_progress.h.

References arb_assert, and ArbProgress::counter::inc_by().

Referenced by arb_progress::inc_by().

void ArbProgress::nestable::inc_to ( SINT  x)
inline

Definition at line 205 of file arb_progress.h.

References ArbProgress::counter::inc_to().

Referenced by arb_progress::inc_to().

void ArbProgress::nestable::inc_to_avoid_overflow ( SINT  x)
inline

Definition at line 206 of file arb_progress.h.

References ArbProgress::counter::inc_to_avoid_overflow().

Referenced by arb_progress::inc_to_avoid_overflow().

void ArbProgress::nestable::done ( )
inline

Definition at line 207 of file arb_progress.h.

References ArbProgress::counter::done().

Referenced by arb_progress::done().

void ArbProgress::nestable::auto_subtitles ( const char *  prefix)
inline

Definition at line 208 of file arb_progress.h.

References ArbProgress::counter::auto_subtitles().

Referenced by arb_progress::auto_subtitles().

static void ArbProgress::nestable::show_comment ( const char *  comment)
inlinestatic

Definition at line 210 of file arb_progress.h.

References ArbProgress::LEVEL_SUBTITLE, and set_text().

Referenced by arb_progress::show_comment().

bool ArbProgress::nestable::owns ( const counter *  pwnd) const
inline

Definition at line 214 of file arb_progress.h.

Referenced by ArbProgress::counter::has_correct_ownership(), and is_correct_owner().

bool ArbProgress::nestable::is_correct_owner ( ) const
inline

Definition at line 215 of file arb_progress.h.

References ArbProgress::counter::owned_by(), and owns().

Referenced by nestable().

Member Data Documentation

char* ArbProgress::nestable::name
protected

Definition at line 125 of file arb_progress.h.

bool ArbProgress::nestable::has_title
protected

Definition at line 131 of file arb_progress.h.

counter* ArbProgress::nestable::cntr
protected

Definition at line 132 of file arb_progress.h.

Referenced by ~nestable().

weightable ArbProgress::nestable::speed
protected

Definition at line 133 of file arb_progress.h.

nestable * nestable::recent = NULp
staticprotected

Definition at line 135 of file arb_progress.h.

Referenced by create(), and nestable().

arb_status_implementation * nestable::impl = NULp
staticprotected

Definition at line 136 of file arb_progress.h.

Referenced by aborted(), and create().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.8