View source

''This page describes the TaskDepender database interface.''

== Description ==

[[Types]]

== Interface functions ==

For the database as a whole the following interface functions are available:
{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description''' || '''Input'''
|- valign="top"
| <tt>[[tdd_create]]</tt> || Creates a new TaskDepender database. || <tt>char* filename</tt>
|- valign="top"
| <tt>[[tdd_open]]</tt> || Opens an existing TaskDepender database. || <tt>char* filename</tt>
|}


{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description'''
|- valign="top"
| <tt>[[tdd_undo]]</tt> || Performs a rollback to the last save-point.
|- valign="top"
| <tt>[[tdd_save]]</tt> || Commits all the last actions and consequently saves the database.
|- valign="top"
| <tt>[[tdd_close]]</tt> || Discards all the last unsaved actions and gracefully closes the database.
|}



The following functions are defined that update the database contents and require input from the user:


{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description''' || '''Input'''
|- valign="top"
| <tt>[[tdd_add_task]]</tt> || Add a task to the diagram. || <tt>[[Tasks_database_table#Interface_structure|tdd_task]] task</tt>
|- valign="top"
| <tt>[[tdd_add_deliverable]]</tt> || Add a deliverable to the diagram. || <tt>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] deliverable</tt>
|- valign="top"
| <tt>[[tdd_connect]]</tt> || Create a connection between the selected task(s) and deliverable(s). || <tt>bool is_dependency</tt>
|- valign="top"
| <tt>[[tdd_update_task]]</tt> || Update the properties of the selected task. || <tt>[[Tasks_database_table#Interface_structure|tdd_task]] task</tt>
|- valign="top"
| <tt>[[tdd_update_deliverable]]</tt> || Update the properties of the selected deliverable. || <tt>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] deliverable</tt>
|- valign="top"
| <tt>[[tdd_select_task]]</tt> || Select a task.|| <tt>uint32 task_id</tt>
|- valign="top"
| <tt>[[tdd_select_deliverable]]</tt> || Select a deliverable.|| <tt>uint32 deliverable_id</tt>
|- valign="top"
| <tt>[[tdd_deselect_task]]</tt> || Deselect a task.|| <tt>uint32 task_id</tt>
|- valign="top"
| <tt>[[tdd_deselect_deliverable]]</tt> || Deselect a deliverable.|| <tt>uint32 deliverable_id</tt>
|}


The following functions update the database but do not require input from the user:

{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description'''
|- valign="top"
| <tt>[[tdd_disconnect]]</tt> || Delete the connection between the selected task(s) and deliverable(s).
|- valign="top"
| <tt>[[tdd_delete]]</tt> || Delete the selected task(s) and deliverable(s).
|- valign="top"
| <tt>[[tdd_cut]]</tt> || Moves all the selected task(s) and deliverable(s) to the 'clipboard'.
|- valign="top"
| <tt>[[tdd_paste]]</tt> || Paste all the task(s) and deliverable(s) on the 'clipboard' into the current container.
|- valign="top"
| <tt>[[tdd_enter_task]]</tt> || Enter the selected task.
|- valign="top"
| <tt>[[tdd_level_up]]</tt> || Leave the current container task.
|- valign="top"
| <tt>[[tdd_clear_selection]]</tt> || Deselect all the selected elements.
|}


The following query functions are defined that require input from the user and return an array filled with interface structures:

{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description''' || '''Input''' || '''Output'''
|- valign="top"
| <tt>[[tdd_get_task_deliverables]]</tt> || Retrieve all the deliverables of the task. || <tt>uint32 task_id</tt> || <tt>uint num_deliverables<br>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] *deliverableList</tt>
|- valign="top"
| <tt>[[tdd_get_dependent_tasks]]</tt> || Retrieve all the tasks that are dependent on the deliverable. || <tt>uint32 deliverable_id</tt> || <tt>uint num_deliverables<br>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] *taskList</tt>
|}


The following query functions are defined that require no input from the user and return an array filled with interface structures:

{| valign="top" border="1" cellpadding="3" cellspacing="0"
|- style="color:white; background-color:#000000;" |
| '''Function''' || '''Description''' || '''Output'''
|- valign="top"
| <tt>[[tdd_get_all_tasks]]</tt> || Retrieve all the tasks in the database.|| <tt>uint num_tasks<br>[[Tasks_database_table#Interface_structure|tdd_task]] *taskList</tt>
|- valign="top"
| <tt>[[tdd_get_all_deliverables]]</tt> || Retrieve all the deliverables in the database. || <tt>uint num_deliverables<br>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] *deliverableList</tt>
|- valign="top"
| <tt>[[tdd_get_tasks]]</tt> || Retrieve all the tasks in the diagram.|| <tt>uint num_tasks<br>[[Tasks_database_table#Interface_structure|tdd_task]] *taskList</tt>
|- valign="top"
| <tt>[[tdd_get_deliverables]]</tt> || Retrieve all the deliverables in the diagram. || <tt>uint num_deliverables<br>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] *deliverableList</tt>
|- valign="top"
| <tt>[[tdd_get_connections]]</tt> || Retrieve the connections in the diagram. || <tt>uint num_connections<br>[[Connections_database_table#Interface_structure|tdd_connection]] *connectionList</tt>
|- valign="top"
| <tt>[[tdd_get_selected_tasks]]</tt> || Retrieve all the selected tasks.|| <tt>uint num_tasks<br>[[Tasks_database_table#Interface_structure|tdd_task]] *taskList</tt>
|- valign="top"
| <tt>[[tdd_get_selected_deliverables]]</tt> || Retrieve all the selected deliverables. || <tt>uint num_deliverables<br>[[Deliverables_database_table#Interface_structure|tdd_deliverable]] *deliverableList</tt>
|}


----
* [[Database]]