/ gwcatalogstats.h / Functions / Description

Functions



gw_catalog_get_total_disks

Gets the number of disks in the catalog.
gint gw_catalog_get_total_disks ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the number of disks in the catalog tree.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the number of disks.
Returns -1 when an error occured..


gw_catalog_get_total_folders

Gets the number of folders in the catalog.
gint gw_catalog_get_total_folders ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the number of folders in the catalog tree. It's the number of all folders (and subfolders).

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the number of folders.
Returns -1 when an error occured..


gw_catalog_get_total_files

Gets the number of files in the catalog.
gint gw_catalog_get_total_files ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the number of files in the catalog tree. It's the number of files in all folders (and subfolders).

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the number of files.
Returns -1 when an error occured..


gw_catalog_get_total_capacity

Gets the total capacity of the catalog.
long double gw_catalog_get_total_capacity ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the total capacity of the catalog. This capacity is based on each capacity disk.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the total capacity of catalog.
Returns -1 when an error occured..


gw_catalog_get_total_used_space

Gets the total used space of the catalog.
long double gw_catalog_get_total_used_space ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the total used space of the catalog. This capacity is based on used space of each disk.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the total used space of catalog.
Returns -1 when an error occured..


gw_catalog_get_total_free_space

Gets the total free space of the catalog.
long double gw_catalog_get_total_free_space ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the total free space of the catalog. This capacity is based on free space of each disk.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the total free space of catalog.
Returns -1 when an error occured..


gw_catalog_get_num_disk_with_type

Gets the number of disks of one type.
gint gw_catalog_get_num_disk_with_type ( GtkCTree *ctree, GtkCTreeNode *node, gchar *type);
This function gets the number of disks of one type.
"Other" is the type for all other unreconized disk type.
Warning : this function is too CRAZY!! To used even if you know what you do.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root
type the disk type to select

Result: the number of disks of this type.
Returns -1 when an error occured..


gw_disk_get_total_folders

Gets the number of folders in the disk.
gint gw_disk_get_total_folders ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the number of folders in the disk in the catalog tree. It's the number of all folders (and subfolders).

Parameters
ctree the tree where is the catalog
node the node in the tree where is the disk root

Result: the number of folders.
Returns -1 when an error occured..


gw_disk_get_total_files

Gets the number of files in the disk.
gint gw_disk_get_total_files ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the number of files in the disk in the catalog tree. It's the number of files in all folders (and subfolders).

Parameters
ctree the tree where is the catalog
node the node in the tree where is the disk root

Result: the number of files.
Returns -1 when an error occured. .


gw_disk_get_max_num

Gets the number of files in the disk.
gint gw_disk_get_max_num ( GtkCTree *ctree, GtkCTreeNode *root);
This function gets the biggest disk number archive.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the catalog root

Result: the max number archive disk.
Returns -1 when an error occured..


gw_disk_name_is_exist

Gets if the disk name exist
gboolean gw_disk_name_is_exist ( gchar *name);
This function gets if the disk name is allready used by another disk. Warning : in future new parameters => GtkCTree, GtkCTreeNode!!

Parameters
name the disk name

Result: is exist or no.
Returns FALSE when an error occured..


gw_disk_num_is_exist

Gets if the disk number archive exist
gboolean gw_disk_num_is_exist ( gint num);
This function gets if the disk number archive is allready used by another disk. Warning : in future new parameters => GtkCTree, GtkCTreeNode!!

Parameters
name the disk number archive

Result: is exist or no.
Returns FALSE when an error occured..


gw_folder_get_catalog

Gets the catalog of the folder
GtkCTreeNode * gw_folder_get_catalog ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the catalog of the folder.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the folder

Result: the node in the tree where is the catalog root..


gw_folder_get_disk

Gets the disk of the folder
GtkCTreeNode * gw_folder_get_disk ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the disk of the folder.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the folder

Result: the node in the tree where is the disk root.
Returns NULL when an error occured..


gw_folder_get_disk_name

Gets the disk name of the folder
gchar * gw_folder_get_disk_name ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the disk name of the folder.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the folder

Result: the disk name. Must be freed with g_free().
Returns NULL when an error occured..


gw_folder_get_disk_type

Gets the disk type of the folder
gchar * gw_folder_get_disk_type ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the disk type of the folder.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the folder

Result: the disk type. Must be freed with g_free().
Returns NULL when an error occured..


gw_folder_get_location_on_disk

Gets the folder location on the disk
gchar * gw_folder_get_location_on_disk ( GtkCTree *ctree, GtkCTreeNode *node);
This function gets the folder location on the disk.

Parameters
ctree the tree where is the catalog
node the node in the tree where is the folder

Result: the full location of the folder. Must be freed with g_free().
Returns NULL when an error occured..


gw_disk_get_num_archive

Checks if the disk number archive is valid
gint gw_disk_get_num_archive ( gchar *num);
This function checks if the disk number archive is valid. In order to be valid the number archive must be unique. If is not valid the function generates a valid number archive. This new number archive is not an allready used number archive. It's calculed with : gw_disk_get_max_num + 1.
If the archive number is valid the function returns this number.

Parameters
num the number archive

Result: a valid number archive.
Returns -1 when an error occured..


gw_disk_get_name

Checks if the disk name is valid
gchar * gw_disk_get_name ( gchar *name);
This function checks if the disk name is valid. In order to be valid the name must be unique. If is not valid the function generates a valid name. This new name is not an allready used name. It's calculed with : "name ( i)" (where i is an incremental number).
If the name is valid the function returns this name.

Parameters
num the name

Result: a valid name. Must be freed with g_free().
Returns NULL when an error occured..