MrpResource

MrpResource — represents a resource in the project.

Functions

MrpResource * mrp_resource_new ()
const gchar * mrp_resource_get_name ()
void mrp_resource_set_name ()
const gchar * mrp_resource_get_short_name ()
void mrp_resource_set_short_name ()
void mrp_resource_assign ()
GList * mrp_resource_get_assignments ()
GList * mrp_resource_get_assigned_tasks ()
gint mrp_resource_compare ()
MrpCalendar * mrp_resource_get_calendar ()
void mrp_resource_set_calendar ()

Properties

gpointer calendar Read / Write
float cost Read / Write
char * email Read / Write
MrpGroup * group Read / Write
char * name Read / Write
char * note Read / Write
char * short-name Read / Write
int type Read / Write
int units Read / Write

Signals

void assignment-added Run Last
void assignment-removed Run Last

Types and Values

#define MRP_TYPE_RESOURCE
enum MrpResourceType
  MrpResource

Object Hierarchy

    GObject
    ╰── MrpObject
        ╰── MrpResource

Includes

#include <libplanner/mrp-resource.h>

Description

A resource has got a name.

Resources come in MrpResourceType: work, material.

A resource has got a cost.

A resource can belong to an MrpGroup. An MrpProject maintains a list of MrpGroup and can designates one as the default. If you specify a default group, every new resource that you add will be placed in this group. Of course, you can still change the group to another as needed.

A resource lists the assignments it is involved in. It knows about its assigned tasks.

A resource can use its own MrpCalendar instead of the project calendar.

Resources are ordered.

Administrative data can be associated: an email, a note.

Functions

mrp_resource_new ()

MrpResource *
mrp_resource_new (void);

Creates a new empty resource.

Returns

the newly created resource.

mrp_resource_get_name ()

const gchar *
mrp_resource_get_name (MrpResource *resource);

Retrieves the name of resource .

Parameters

resource

an MrpResource

  

Returns

the name

mrp_resource_set_name ()

void
mrp_resource_set_name (MrpResource *resource,
                       const gchar *name);

Sets the name of resource .

Parameters

resource

an MrpResource

  

name

new name of resource

 

mrp_resource_get_short_name ()

const gchar *
mrp_resource_get_short_name (MrpResource *resource);

Retrieves the short_name of resource .

Parameters

resource

an MrpResource

  

Returns

the short name

mrp_resource_set_short_name ()

void
mrp_resource_set_short_name (MrpResource *resource,
                             const gchar *short_name);

Sets the short name of resource .

Parameters

resource

an MrpResource

  

short_name

new short name of resource

 

mrp_resource_assign ()

void
mrp_resource_assign (MrpResource *resource,
                     MrpTask *task,
                     gint units);

Assigns resource to task by the given amount of units . A value of 100 units corresponds to fulltime assignment.

Parameters

resource

an MrpResource

  

task

an MrpTask

  

units

the amount of units of assignment

  

mrp_resource_get_assignments ()

GList *
mrp_resource_get_assignments (MrpResource *resource);

Retrieves the assignments that this resource has. If caller needs to manipulate the returned list, a copy of it needs to be made.

Parameters

resource

an MrpResource.

  

Returns

The assignments of resource . It should not be freed.

mrp_resource_get_assigned_tasks ()

GList *
mrp_resource_get_assigned_tasks (MrpResource *resource);

Retrieves a list of all the tasks that this resource is assigned to. It is basically a convenience wrapper around mrp_resource_get_assignments().

Parameters

resource

an MrpResource

  

Returns

A list of the tasks that this resource is assigned to. Needs to be freed when not used anymore.

mrp_resource_compare ()

gint
mrp_resource_compare (gconstpointer a,
                      gconstpointer b);

Comparison routine for resources. It is suitable for sorting, and only compares the resource name.

Parameters

a

an MrpResource

  

b

an MrpResource

  

Returns

-1 if a is less than b , 1 id a is greater than b , and 1 if equal.

mrp_resource_get_calendar ()

MrpCalendar *
mrp_resource_get_calendar (MrpResource *resource);

Retrieves the calendar that is used for resource . If no calendar is set, NULL is returned, which means the project default calendar.

Parameters

resource

an MrpResource

  

Returns

a MrpCalendar, or NULL if no specific calendar is set.

mrp_resource_set_calendar ()

void
mrp_resource_set_calendar (MrpResource *resource,
                           MrpCalendar *calendar);

Sets the calendar to use for resource . NULL means to use the project default calendar.

Parameters

resource

an MrpResource

  

calendar

the MrpCalendar to set, or NULL

  

Types and Values

MRP_TYPE_RESOURCE

#define MRP_TYPE_RESOURCE         (mrp_resource_get_type ())

enum MrpResourceType

The type of the resource, work or material.

Members

MRP_RESOURCE_TYPE_NONE

invalid type (unset)

  

MRP_RESOURCE_TYPE_WORK

work resource

  

MRP_RESOURCE_TYPE_MATERIAL

material resource

  

MrpResource

typedef struct _MrpResource MrpResource;

Object representing a resource in the project.

Property Details

The “calendar” property

  “calendar”                 gpointer

The calendar this resource uses.

Owner: MrpResource

Flags: Read / Write

The “cost” property

  “cost”                     float

The standard cost of the resource.

Owner: MrpResource

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The “email” property

  “email”                    char *

The email address of the resource.

Owner: MrpResource

Flags: Read / Write

Default value: NULL

The “group” property

  “group”                    MrpGroup *

The group that the resource belongs to.

Owner: MrpResource

Flags: Read / Write

The “name” property

  “name”                     char *

The name of the resource.

Owner: MrpResource

Flags: Read / Write

Default value: NULL

The “note” property

  “note”                     char *

Resource note.

Owner: MrpResource

Flags: Read / Write

Default value: ""

The “short-name” property

  “short-name”               char *

The shorter name, initials or nickname of the resource.

Owner: MrpResource

Flags: Read / Write

Default value: NULL

The “type” property

  “type”                     int

The type of resource this is.

Owner: MrpResource

Flags: Read / Write

Allowed values: [0,2]

Default value: 1

The “units” property

  “units”                    int

The amount of units this resource has.

Owner: MrpResource

Flags: Read / Write

Allowed values: >= -1

Default value: 0

Signal Details

The “assignment-added” signal

void
user_function (MrpResource   *resource,
               MrpAssignment *assignment,
               gpointer       user_data)

emitted when assignment is added.

Parameters

resource

the object which received the signal.

  

assignment

the added MrpAssignment.

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “assignment-removed” signal

void
user_function (MrpResource   *resource,
               MrpAssignment *assignment,
               gpointer       user_data)

emitted when assignment is removed.

Parameters

resource

the object which received the signal.

  

assignment

the removed MrpAssignment.

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.34.0