| Re: creating documentation file [message #43121 is a reply to message #43120] |
Tue, 15 March 2005 08:18   |
Antonio Santiago
Messages: 201
Registered: February 2004
|
Senior Member |
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<HTML>
<HEAD>
<!-- Generated by IDLdoc 1.5 Build date: Tue Jul 1 12:15:42 2003 on Tue Mar 15 15:50:42 2005 -->
<TITLE>product__define.pro</TITLE>
<LINK REL=stylesheet TYPE="text/css" HREF="../idldoc.css" TITLE="main_style">
</HEAD>
<SCRIPT>
function setTitle()
{
parent.document.title="product__define.pro (GenRad 2.0)";
}
</SCRIPT>
<BODY CLASS="standard" onload="setTitle();">
<TABLE BORDER="0" CELLPADDING="1" CELLSPACING="0" WIDTH="100%">
<TR><TD VALIGN="TOP" BGCOLOR="#DDDDFF">
<TABLE BORDER="0" CELLPADDING="1" CELLSPACING="1">
<TR CLASS="navbar">
<TD CLASS="navbar_linked"> <A HREF="../overview.html">Overview</A> </TD>
<TD CLASS="navbar_linked"> <A HREF="directory-overview.html">Directory</A> </TD >
<TD CLASS="navbar_linked"> <A HREF="../full-index.html">Index</A> </TD>
<TD CLASS="navbar_linked"> <A HREF="../search-page.html">Search</A> </TD>
<TD CLASS="navbar_selected"> File </TD>
<TD CLASS="navbar_linked"> <A HREF="../help.html">Help</A> </TD>
<TD> Etc </TD>
</TR>
</TABLE>
</TD>
<TD> </TD>
<TD ROWSPAN="3" ALIGN="right"><FONT CLASS="logo"><NOBR>GenRad 2.0</NOBR></FONT><BR><FONT CLASS="version"><NOBR>GRAHI</NOBR></FONT><BR><FONT CLASS="version" STYLE="font-weight: bold">Developer Documentation</FONT></TD>
</TR>
<TR><TD CLASS="navbar_small"> <A HREF="pluginxml__define.html">prev file</A> | next file & amp;nbsp; & amp;nbsp; <NOBR><A HREF="product__define.html" TARGET="_top">view single page</A> | <A HREF="../index.html" TARGET="_top">view frames</A></NOBR></TD></TR>
<TR><TD CLASS="navbar_small">SUMMARY: <A HREF="#_fields_summary">fields</A> | <A HREF="#_routine_summary">routine</A> DETAILS: <A HREF="#_routine_details">routine</A></TD></TR>
<TR><TD></TD></TR>
</TABLE>
<HR CLASS="divider">
<P>
<FONT CLASS="directory">./model</FONT></BR>
<FONT CLASS="file">File product__define.pro</FONT>
<P>
<DL>
<DT CLASS="attribute">Last modification date:
<DD CLASS="attribute_item">Mon Mar 14 18:44:16 2005</DD></DT>
</DL>
<P>
Product class represents a radar product to
generate. Maintains associations with the plugins which is based
plugin information and parent dependencies.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="listing">
<TR><TD COLSPAN=2 CLASS="title">
<A NAME="_fields_summary">Fields Summary</A>
</TD></TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">PARENTS</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
object reference
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Linkedlist of products that represnts parent or input
dependencies
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">CHILDREN</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
object reference
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Linkedlist of products that represent children
dependencies.
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">EXECUTED</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
byte
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Indicates if the product has been generated.
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">NAME</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
string
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Name of the product.
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">DESCRIPTION</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
string
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Description of the product.
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">PLUGIN</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
object reference
</NOBR></FONT>
</TD>
<TD VALIGN="top">
Plugin object that implements the product.
</TD>
</TR>
<TR>
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT CLASS="param_name">PLUGIN_INFO</FONT><BR>
<FONT CLASS="param_attrib"><NOBR>
object reference
</NOBR></FONT>
</TD>
<TD VALIGN="top">
PluginInfo object that has the plugin
information.
</TD>
</TR>
</TABLE>
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="listing">
<TR><TD CLASS="title">
<A NAME="_routine_summary">Routine Summary</A>
<FONT CLASS="list_tagline">15 routines</FONT>
</TD></TR>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product__define">Product__define</A></P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"></P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_Product::Init">Product::Init</A>()</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Creates and initializes the object.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::Cleanup">Product::Cleanup</A></P></TD> <TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Frees the resources used by the object.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::SetProperty">Product::SetProperty</A>, [NAME=<EM>string</EM>], [DESCRIPTION=<EM>string</EM>]</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Set individual property values.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::GetProperty">Product::GetProperty</A>, NAME=<EM>NAME</EM>, DESCRIPTION=<EM>DESCRIPTION</EM></P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Get individual properties.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::AddParent">Product::AddParent</A>, product</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Sets a parent dependency for the object and automatically sets a reference from parent to child.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::AddChild">Product::AddChild</A>, product</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Sets a child dependency for the object and set a reference from child to parent.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_Product::GetParents">Product::GetParents</A>()</P ></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Gets the parent dependencies of the product </P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_Product::GetChildren">Product::GetChildren</A>() </P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Gets the children referencies.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::MakeProduct">Product::MakeProduct</A></P ></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Executes the plugin associated with the Product to generate the output data.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::SetPlugin">Product::SetPlugin</A>, plugin</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Sets the Plugin object on which is based the Product.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::SetPluginInfo">Product::SetPluginInfo</A >, plugin_info</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Sets the PluginInfo object that stores the Plugin information.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_Product::AssocPluginInfo2Plugin">Product::AssocPluginInfo2Plugin </A></P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Creates an association from PluginInfo to Plugin object of the Product.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_Product::GetPlugin">Product::GetPlugin</A>()</P ></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Gets the Plugin object on which the Product is based.</P></TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_Product::GetPluginInfo">Product::GetPluginInfo</A >()</P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Gets the PluginInfo object with the information of the Plugin on which the Product is based.</P></TD></TR></TABLE>
</TABLE>
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="listing">
<TR><TD CLASS="title"><A NAME="_routine_details">Routine Details</A></TD></TR>
</TABLE>
<P>
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product__define">
Product__define
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product__define</P></TD></TR></TABLE>
<P>
<P>
<DL>
<DT CLASS="attribute">Requires
<DD CLASS="attribute_item">
linkedlist logmsg
</DD></DT>
<DT CLASS="attribute">History
<DD CLASS="attribute_item">
Fri Jan 14 17:08:04 2005, Antonio Santiago
(santiago@grahi.upc.edu - http://asantiago.gentelibre.org)
</DD></DT>
<DT CLASS="attribute">Author
<DD CLASS="attribute_item">
Antonio Santiago
(santiago@grahi.upc.edu - http://asantiago.gentelibre.org)
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::Init">
Product::Init
</A></H3>
</TD><TD ALIGN="right">
<FONT CLASS="param_attrib">private </FONT>
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function Product::Init()</P></TD></TR></TABLE>
<P>
Creates and initializes the object.
<P>
<DL>
<DT CLASS="attribute">Returns
<DD CLASS="attribute_item">
1 if successful; 0 otherwise
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::Cleanup">
Product::Cleanup
</A></H3>
</TD><TD ALIGN="right">
<FONT CLASS="param_attrib">private </FONT>
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::Cleanup</P></TD></TR></TABLE>
<P>
Frees the resources used by the object.
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::SetProperty">
Product::SetProperty
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::SetProperty, [<A HREF=#_Product::SetProperty_keyword_NAME>NAME</A>=<EM>string </EM>], [<A HREF=#_Product::SetProperty_keyword_DESCRIPTION>DESCRIPTION </A>=<EM>string</EM>]</P></TD></TR></TABLE>
<P>
Set individual property values.
<P>
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Keywords</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::SetProperty_keyword_NAME"/>
<FONT CLASS="param_name">NAME</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, optional</NOBR><BR>
<NOBR>string</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
Name of the product.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::SetProperty_keyword_DESCRIPTION"/>
<FONT CLASS="param_name">DESCRIPTION</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, optional</NOBR><BR>
<NOBR>string</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
Description of the
products.
</TD>
</TR>
</TABLE>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::GetProperty">
Product::GetProperty
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::GetProperty, <A HREF=#_Product::GetProperty_keyword_NAME>NAME</A>=<EM>NAME </EM>, <A HREF=#_Product::GetProperty_keyword_DESCRIPTION>DESCRIPTION </A>=<EM>DESCRIPTION</EM></P></TD></TR></TABLE>
<P>
Get individual properties.
<i>(See SetProperty methos)</i>
<P>
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Keywords</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::GetProperty_keyword_NAME"/>
<FONT CLASS="param_name">NAME</FONT><BR>
<FONT CLASS="param_attrib">
</FONT>
</TD>
<TD VALIGN="top">
.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::GetProperty_keyword_DESCRIPTION"/>
<FONT CLASS="param_name">DESCRIPTION</FONT><BR>
<FONT CLASS="param_attrib">
</FONT>
</TD>
<TD VALIGN="top">
.
</TD>
</TR>
</TABLE>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::AddParent">
Product::AddParent
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::AddParent, <A HREF=#_Product::AddParent_param_product>product</A></P></TD ></TR></TABLE>
<P>
Sets a parent dependency for the object and automatically sets a
reference from parent to child.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Parameters</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::AddParent_param_product"/>
<FONT CLASS="param_name">product</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, required</NOBR><BR>
<NOBR>Product</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
Product object that
represents a parent dependency.
</TD>
</TR>
</TABLE>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::AddChild">
Product::AddChild
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::AddChild, <A HREF=#_Product::AddChild_param_product>product</A></P></TD ></TR></TABLE>
<P>
Sets a child dependency for the object and set a reference from
child to parent.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Parameters</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::AddChild_param_product"/>
<FONT CLASS="param_name">product</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, required</NOBR><BR>
<NOBR>Product</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
Product object that
represents a child dependency.
</TD>
</TR>
</TABLE>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::GetParents">
Product::GetParents
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function Product::GetParents()</P></TD></TR></TABLE>
<P>
Gets the parent dependencies of the product
<P>
<DL>
<DT CLASS="attribute">Returns
<DD CLASS="attribute_item">
Linkedlist of Product.
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::GetChildren">
Product::GetChildren
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function Product::GetChildren()</P></TD></TR></TABLE>
<P>
Gets the children referencies.
<P>
<DL>
<DT CLASS="attribute">Returns
<DD CLASS="attribute_item">
Linkedlist of Products
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::MakeProduct">
Product::MakeProduct
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::MakeProduct</P></TD></TR></TABLE>
<P>
Executes the plugin associated with the Product to generate the
output data.
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::SetPlugin">
Product::SetPlugin
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::SetPlugin, <A HREF=#_Product::SetPlugin_param_plugin>plugin</A></P></TD ></TR></TABLE>
<P>
Sets the Plugin object on which is based the Product.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Parameters</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::SetPlugin_param_plugin"/>
<FONT CLASS="param_name">plugin</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, required</NOBR><BR>
<NOBR>Plugin</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
Plugin on which is
related.
</TD>
</TR>
</TABLE>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::SetPluginInfo">
Product::SetPluginInfo
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::SetPluginInfo, <A HREF=#_Product::SetPluginInfo_param_plugin_info>plugin_info </A></P></TD></TR></TABLE>
<P>
Sets the PluginInfo object that stores the Plugin information.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters">
<TR BGCOLOR="#EEEEFF" CLASS="small_title">
<TD COLSPAN=2>Parameters</TD>
</TR>
<TR BGCOLOR="white" CLASS="parameters">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<A NAME="_Product::SetPluginInfo_param_plugin_info"/>
<FONT CLASS="param_name">plugin_info</FONT><BR>
<FONT CLASS="param_attrib">
<NOBR>in, required</NOBR><BR>
<NOBR>PluginInfo</NOBR>
</FONT>
</TD>
<TD VALIGN="top">
PluginInfo object.
</TD>
</TR>
</TABLE>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::AssocPluginInfo2Plugin">
Product::AssocPluginInfo2Plugin
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure Product::AssocPluginInfo2Plugin</P></TD></TR></TABLE>
<P>
Creates an association from PluginInfo to Plugin object of the
Product.
<P>
<DL>
<DT CLASS="attribute">Pre-condition
<DD CLASS="attribute_item">
Product object must has references to a valid Plugin and
PluginInfo objects.
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::GetPlugin">
Product::GetPlugin
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function Product::GetPlugin()</P></TD></TR></TABLE>
<P>
Gets the Plugin object on which the Product is based.
<P>
<DL>
<DT CLASS="attribute">Returns
<DD CLASS="attribute_item">
Plugin
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<TABLE WIDTH="100%" BORDER="0"><TR><TD>
<H3 CLASS="routine"><A NAME="_Product::GetPluginInfo">
Product::GetPluginInfo
</A></H3>
</TD><TD ALIGN="right">
</TD></TR></TABLE>
<TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function Product::GetPluginInfo()</P></TD></TR></TABLE>
<P>
Gets the PluginInfo object with the information of the Plugin on
which the Product is based.
<P>
<DL>
<DT CLASS="attribute">Returns
<DD CLASS="attribute_item">
PluginInfo
</DD></DT>
</DL>
<P>
<P>
<P>
<HR CLASS="divider">
<FONT CLASS="tagline">Produced by IDLdoc 1.5 on Tue Mar 15 15:50:42 2005</FONT>
</BODY></HTML>
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
