NcmTimer

NcmTimer — A timer with ETA support.

Properties

gchar * name Read / Write / Construct
guint task-len Read
guint task-pos Read

Types and Values

Object Hierarchy

    GObject
    ╰── NcmTimer

Description

FIXME

Functions

ncm_timer_new ()

NcmTimer *
ncm_timer_new (void);

FIXME

Returns

FIXME.

[transfer full]


ncm_timer_ref ()

NcmTimer *
ncm_timer_ref (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer full]


ncm_timer_free ()

void
ncm_timer_free (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_clear ()

void
ncm_timer_clear (NcmTimer **nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_set_name ()

void
ncm_timer_set_name (NcmTimer *nt,
                    const gchar *name);

FIXME

Parameters

nt

FIXME

 

name

FIXME

 

ncm_timer_elapsed ()

gdouble
ncm_timer_elapsed (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME


ncm_timer_elapsed_dhms ()

void
ncm_timer_elapsed_dhms (NcmTimer *nt,
                        guint *elap_day,
                        guint *elap_hour,
                        guint *elap_min,
                        gdouble *elap_sec);

FIXME

Parameters

nt

FIXME

 

elap_day

FIXME.

[out]

elap_hour

FIXME.

[out]

elap_min

FIXME.

[out]

elap_sec

FIXME.

[out]

ncm_timer_elapsed_dhms_str ()

gchar *
ncm_timer_elapsed_dhms_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_start ()

void
ncm_timer_start (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_stop ()

void
ncm_timer_stop (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_continue ()

void
ncm_timer_continue (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_start ()

void
ncm_timer_task_start (NcmTimer *nt,
                      guint task_len);

FIXME

Parameters

nt

FIXME

 

task_len

FIXME

 

ncm_timer_task_pause ()

void
ncm_timer_task_pause (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_continue ()

void
ncm_timer_task_continue (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_add_tasks ()

void
ncm_timer_task_add_tasks (NcmTimer *nt,
                          guint ptasks);

FIXME

Parameters

nt

FIXME

 

ptasks

FIXME

 

ncm_timer_task_increment ()

void
ncm_timer_task_increment (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_accumulate ()

void
ncm_timer_task_accumulate (NcmTimer *nt,
                           guint nitens);

FIXME

Parameters

nt

FIXME

 

nitens

FIXME

 

ncm_timer_task_estimate_by_time ()

guint
ncm_timer_task_estimate_by_time (NcmTimer *nt,
                                 gdouble sec);

Estimate how many task points would take sec seconds.

Parameters

nt

FIXME

 

sec

time in seconds

 

Returns

the estimated number of points.


ncm_timer_task_is_running ()

gboolean
ncm_timer_task_is_running (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_end ()

gboolean
ncm_timer_task_end (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_mean_time ()

gdouble
ncm_timer_task_mean_time (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME


ncm_timer_task_time_left ()

gdouble
ncm_timer_task_time_left (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME


ncm_timer_task_elapsed_str ()

const gchar *
ncm_timer_task_elapsed_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_mean_time_str ()

const gchar *
ncm_timer_task_mean_time_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_time_left_str ()

const gchar *
ncm_timer_task_time_left_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_start_datetime_str ()

const gchar *
ncm_timer_task_start_datetime_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_cur_datetime_str ()

const gchar *
ncm_timer_task_cur_datetime_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_end_datetime_str ()

const gchar *
ncm_timer_task_end_datetime_str (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Returns

FIXME.

[transfer none]


ncm_timer_task_log_elapsed ()

void
ncm_timer_task_log_elapsed (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_log_mean_time ()

void
ncm_timer_task_log_mean_time (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_log_time_left ()

void
ncm_timer_task_log_time_left (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_log_start_datetime ()

void
ncm_timer_task_log_start_datetime (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_log_cur_datetime ()

void
ncm_timer_task_log_cur_datetime (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

ncm_timer_task_log_end_datetime ()

void
ncm_timer_task_log_end_datetime (NcmTimer *nt);

FIXME

Parameters

nt

FIXME

 

Types and Values

NCM_TIMER_SEC_FORMAT

#define NCM_TIMER_SEC_FORMAT "%07.4f"

Property Details

The “name” property

  “name”                     gchar *

Timer's name.

Owner: NcmTimer

Flags: Read / Write / Construct

Default value: "timer"


The “task-len” property

  “task-len”                 guint

Length of the current task.

Owner: NcmTimer

Flags: Read

Default value: 0


The “task-pos” property

  “task-pos”                 guint

Position of the current task, varying from [0, “task-len” - 1]

Owner: NcmTimer

Flags: Read

Default value: 0