GRAHI
Developer Documentation

./model
File product__define.pro

Last modification date:
Mon Mar 14 18:44:16 2005

Product class represents a radar product to generate. Maintains associations with the plugins which is based plugin information and parent dependencies.

Fields Summary
PARENTS
object reference
Linkedlist of products that represnts parent or input dependencies
CHILDREN
object reference
Linkedlist of products that represent children dependencies.
EXECUTED
byte
Indicates if the product has been generated.
NAME
string
Name of the product.
DESCRIPTION
string
Description of the product.
PLUGIN
object reference
Plugin object that implements the product.
PLUGIN_INFO
object reference
PluginInfo object that has the plugin information.

Routine Summary  15 routines

procedure Product__define

function Product::Init()

private

Creates and initializes the object.

procedure Product::Cleanup

private

Frees the resources used by the object.

procedure Product::SetProperty, [NAME=string], [DESCRIPTION=string]

Set individual property values.

procedure Product::GetProperty, NAME=NAME, DESCRIPTION=DESCRIPTION

Get individual properties.

procedure Product::AddParent, product

Sets a parent dependency for the object and automatically sets a reference from parent to child.

procedure Product::AddChild, product

Sets a child dependency for the object and set a reference from child to parent.

function Product::GetParents()

Gets the parent dependencies of the product

function Product::GetChildren()

Gets the children referencies.

procedure Product::MakeProduct

Executes the plugin associated with the Product to generate the output data.

procedure Product::SetPlugin, plugin

Sets the Plugin object on which is based the Product.

procedure Product::SetPluginInfo, plugin_info

Sets the PluginInfo object that stores the Plugin information.

procedure Product::AssocPluginInfo2Plugin

Creates an association from PluginInfo to Plugin object of the Product.

function Product::GetPlugin()

Gets the Plugin object on which the Product is based.

function Product::GetPluginInfo()

Gets the PluginInfo object with the information of the Plugin on which the Product is based.

Routine Details

Product__define

procedure Product__define

Requires
linkedlist logmsg
History
Fri Jan 14 17:08:04 2005, Antonio Santiago (santiago@grahi.upc.edu - http://asantiago.gentelibre.org)
Author
Antonio Santiago (santiago@grahi.upc.edu - http://asantiago.gentelibre.org)


Product::Init

private

function Product::Init()

Creates and initializes the object.

Returns
1 if successful; 0 otherwise


Product::Cleanup

private

procedure Product::Cleanup

Frees the resources used by the object.


Product::SetProperty

procedure Product::SetProperty, [NAME=string], [DESCRIPTION=string]

Set individual property values.

Keywords
NAME
in, optional
string
Name of the product.
DESCRIPTION
in, optional
string
Description of the products.


Product::GetProperty

procedure Product::GetProperty, NAME=NAME, DESCRIPTION=DESCRIPTION

Get individual properties. (See SetProperty methos)

Keywords
NAME
.
DESCRIPTION
.


Product::AddParent

procedure Product::AddParent, product

Sets a parent dependency for the object and automatically sets a reference from parent to child.

Parameters
product
in, required
Product
Product object that represents a parent dependency.


Product::AddChild

procedure Product::AddChild, product

Sets a child dependency for the object and set a reference from child to parent.

Parameters
product
in, required
Product
Product object that represents a child dependency.


Product::GetParents

function Product::GetParents()

Gets the parent dependencies of the product

Returns
Linkedlist of Product.


Product::GetChildren

function Product::GetChildren()

Gets the children referencies.

Returns
Linkedlist of Products


Product::MakeProduct

procedure Product::MakeProduct

Executes the plugin associated with the Product to generate the output data.


Product::SetPlugin

procedure Product::SetPlugin, plugin

Sets the Plugin object on which is based the Product.

Parameters
plugin
in, required
Plugin
Plugin on which is related.


Product::SetPluginInfo

procedure Product::SetPluginInfo, plugin_info

Sets the PluginInfo object that stores the Plugin information.

Parameters
plugin_info
in, required
PluginInfo
PluginInfo object.


Product::AssocPluginInfo2Plugin

procedure Product::AssocPluginInfo2Plugin

Creates an association from PluginInfo to Plugin object of the Product.

Pre-condition
Product object must has references to a valid Plugin and PluginInfo objects.


Product::GetPlugin

function Product::GetPlugin()

Gets the Plugin object on which the Product is based.

Returns
Plugin


Product::GetPluginInfo

function Product::GetPluginInfo()

Gets the PluginInfo object with the information of the Plugin on which the Product is based.

Returns
PluginInfo


Produced by IDLdoc 1.5 on Tue Mar 15 15:50:42 2005