MrpTask

MrpTask — represents a task in the project.

Synopsis




struct      MrpTask;
MrpTask*    mrp_task_new                    (void);
MrpRelation* mrp_task_add_predecessor       (MrpTask *task,
                                             MrpTask *predecessor,
                                             MrpRelationType type,
                                             glong lag,
                                             GError **error);
void        mrp_task_remove_predecessor     (MrpTask *task,
                                             MrpTask *predecessor);
MrpRelation* mrp_task_get_relation          (MrpTask *task_a,
                                             MrpTask *task_b);
MrpRelation* mrp_task_get_predecessor       (MrpTask *task,
                                             MrpTask *predecessor);
MrpRelation* mrp_task_get_successor         (MrpTask *task,
                                             MrpTask *successor);
GList*      mrp_task_get_predecessors       (MrpTask *task);
GList*      mrp_task_get_successors         (MrpTask *task);
gboolean    mrp_task_has_relation_to        (MrpTask *a,
                                             MrpTask *b);
gboolean    mrp_task_has_relation           (MrpTask *task);
MrpTask*    mrp_task_get_parent             (MrpTask *task);
MrpTask*    mrp_task_get_first_child        (MrpTask *task);
MrpTask*    mrp_task_get_next_sibling       (MrpTask *task);
guint       mrp_task_get_n_children         (MrpTask *task);
MrpTask*    mrp_task_get_nth_child          (MrpTask *task,
                                             guint n);
gint        mrp_task_get_position           (MrpTask *task);
mrptime     mrp_task_get_start              (MrpTask *task);
mrptime     mrp_task_get_finish             (MrpTask *task);
gint        mrp_task_get_duration           (MrpTask *task);
GList*      mrp_task_get_assignments        (MrpTask *task);
MrpAssignment* mrp_task_get_assignment      (MrpTask *task,
                                             MrpResource *resource);
void        mrp_task_reset_constraint       (MrpTask *task);
gfloat      mrp_task_get_cost               (MrpTask *task);
GList*      mrp_task_get_assigned_resources (MrpTask *task);
gint        mrp_task_compare                (gconstpointer a,
                                             gconstpointer b);

Object Hierarchy


  GObject
   +----MrpObject
         +----MrpTask

Properties


  "constraint"           MrpConstraint        : Read / Write
  "critical"             gboolean             : Read / Write
  "duration"             gint                 : Read / Write
  "finish"               glong                : Read
  "latest-finish"        glong                : Read
  "latest-start"         glong                : Read
  "name"                 gchararray           : Read / Write
  "note"                 gchararray           : Read / Write
  "percent-complete"     gint                 : Read / Write
  "sched"                MrpTaskSched         : Read / Write
  "start"                glong                : Read
  "type"                 MrpTaskType          : Read / Write
  "work"                 gint                 : Read / Write

Signal Prototypes


"assignment-added"
            void        user_function      (MrpTask *mrptask,
                                            MrpAssignment *arg1,
                                            gpointer user_data);
"assignment-removed"
            void        user_function      (MrpTask *mrptask,
                                            MrpAssignment *arg1,
                                            gpointer user_data);
"child-added"
            void        user_function      (MrpTask *mrptask,
                                            gpointer user_data);
"child-removed"
            void        user_function      (MrpTask *mrptask,
                                            gpointer user_data);
"relation-added"
            void        user_function      (MrpTask *mrptask,
                                            gpointer arg1,
                                            gpointer user_data);
"relation-removed"
            void        user_function      (MrpTask *mrptask,
                                            gpointer arg1,
                                            gpointer user_data);
"task-moved"
            void        user_function      (MrpTask *mrptask,
                                            MrpTask *arg1,
                                            gint arg2,
                                            gpointer user_data);

Description

Details

struct MrpTask

struct MrpTask;

mrp_task_new ()

MrpTask*    mrp_task_new                    (void);

Returns :

mrp_task_add_predecessor ()

MrpRelation* mrp_task_add_predecessor       (MrpTask *task,
                                             MrpTask *predecessor,
                                             MrpRelationType type,
                                             glong lag,
                                             GError **error);

Adds a predecessor task to a task. Depending on type, the predecessor must be started or finished before task can be started or finished, with an optional lag/lead.

`task` :	The task to add predecessor to
`predecessor` :	The predecessor
`type` :	Type of relation
`lag` :	Lag time. If negative, it means lead time.
`error` :
Returns :	The relation that represents the predecessor/successor link.

mrp_task_remove_predecessor ()

void        mrp_task_remove_predecessor     (MrpTask *task,
                                             MrpTask *predecessor);

Removes a predecessor previously added to task.

`task` :	The task to remove a predecessor from
`predecessor` :	The predecessor to remove

mrp_task_get_relation ()

MrpRelation* mrp_task_get_relation          (MrpTask *task_a,
                                             MrpTask *task_b);

`task_a` :	A task
`task_b` :	A task
Returns :	Any relation between two tasks.

mrp_task_get_predecessor ()

MrpRelation* mrp_task_get_predecessor       (MrpTask *task,
                                             MrpTask *predecessor);

`task` :
`predecessor` :
Returns :

mrp_task_get_successor ()

MrpRelation* mrp_task_get_successor         (MrpTask *task,
                                             MrpTask *successor);

`task` :
`successor` :
Returns :

mrp_task_get_predecessors ()

GList*      mrp_task_get_predecessors       (MrpTask *task);

`task` :
Returns :

mrp_task_get_successors ()

GList*      mrp_task_get_successors         (MrpTask *task);

`task` :
Returns :

mrp_task_has_relation_to ()

gboolean    mrp_task_has_relation_to        (MrpTask *a,
                                             MrpTask *b);

`a` :
`b` :
Returns :

mrp_task_has_relation ()

gboolean    mrp_task_has_relation           (MrpTask *task);

`task` :
Returns :

mrp_task_get_parent ()

MrpTask*    mrp_task_get_parent             (MrpTask *task);

`task` :
Returns :

mrp_task_get_first_child ()

MrpTask*    mrp_task_get_first_child        (MrpTask *task);

`task` :
Returns :

mrp_task_get_next_sibling ()

MrpTask*    mrp_task_get_next_sibling       (MrpTask *task);

`task` :
Returns :

mrp_task_get_n_children ()

guint       mrp_task_get_n_children         (MrpTask *task);

`task` :
Returns :

mrp_task_get_nth_child ()

MrpTask*    mrp_task_get_nth_child          (MrpTask *task,
                                             guint n);

`task` :
`n` :
Returns :

mrp_task_get_position ()

gint        mrp_task_get_position           (MrpTask *task);

`task` :
Returns :

mrp_task_get_start ()

mrptime     mrp_task_get_start              (MrpTask *task);

`task` :
Returns :

mrp_task_get_finish ()

mrptime     mrp_task_get_finish             (MrpTask *task);

`task` :
Returns :

mrp_task_get_duration ()

gint        mrp_task_get_duration           (MrpTask *task);

`task` :
Returns :

mrp_task_get_assignments ()

GList*      mrp_task_get_assignments        (MrpTask *task);

`task` :
Returns :

mrp_task_get_assignment ()

MrpAssignment* mrp_task_get_assignment      (MrpTask *task,
                                             MrpResource *resource);

`task` :
`resource` :
Returns :

mrp_task_reset_constraint ()

void        mrp_task_reset_constraint       (MrpTask *task);

task :

mrp_task_get_cost ()

gfloat      mrp_task_get_cost               (MrpTask *task);

`task` :	A task object
Returns :	the cost to complete the task

mrp_task_get_assigned_resources ()

GList*      mrp_task_get_assigned_resources (MrpTask *task);

`task` :
Returns :

mrp_task_compare ()

gint        mrp_task_compare                (gconstpointer a,
                                             gconstpointer b);

`a` :
`b` :
Returns :

Properties

"`constraint`" (MrpConstraint : Read / Write)
"`critical`" (gboolean : Read / Write)
"`duration`" (gint : Read / Write)
"`finish`" (glong : Read)
"`latest-finish`" (glong : Read)
"`latest-start`" (glong : Read)
"`name`" (gchararray : Read / Write)
"`note`" (gchararray : Read / Write)
"`percent-complete`" (gint : Read / Write)
"`sched`" (MrpTaskSched : Read / Write)
"`start`" (glong : Read)
"`type`" (MrpTaskType : Read / Write)
"`work`" (gint : Read / Write)

Signals

The "assignment-added" signal

void        user_function                  (MrpTask *mrptask,
                                            MrpAssignment *arg1,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

The "assignment-removed" signal

void        user_function                  (MrpTask *mrptask,
                                            MrpAssignment *arg1,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

The "child-added" signal

void        user_function                  (MrpTask *mrptask,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.

The "child-removed" signal

void        user_function                  (MrpTask *mrptask,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.

The "relation-added" signal

void        user_function                  (MrpTask *mrptask,
                                            gpointer arg1,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

The "relation-removed" signal

void        user_function                  (MrpTask *mrptask,
                                            gpointer arg1,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

The "task-moved" signal

void        user_function                  (MrpTask *mrptask,
                                            MrpTask *arg1,
                                            gint arg2,
                                            gpointer user_data);

`mrptask` :	the object which received the signal.
`arg1` :
`arg2` :
`user_data` :	user data set when the signal handler was connected.