Module UnitCategories

This part of BtUtils is supposed to take care of unit categories definitions.

Functions

getAllCategoryNames () Returns array of names of available categories.
getCategoryTypes (qualifiedName) Get types in given category.
loadCategory (qualifiedName) Returns entry corresponding to a given category.
saveCategory (catDefinition) Saves a category.


Functions

getAllCategoryNames ()
Returns array of names of available categories.

Returns:

    {string}
getCategoryTypes (qualifiedName)
Get types in given category.

Parameters:

  • qualifiedName string Qualified name of the category.

Returns:

    {tab} List of tables with name of units in the category.
loadCategory (qualifiedName)
Returns entry corresponding to a given category.

Parameters:

  • qualifiedName string Qualified name of the category.

Returns:

    tab Table containing a list of tables in types that describe the name of units in the category.
saveCategory (catDefinition)
Saves a category.

Parameters:

  • catDefinition tab Category definition containing project name, category name and types containing list of names of the units.
generated by LDoc 1.4.3 Last updated 2017-06-01 23:07:48