All Categories Class Hierarchy This Category Previous Next Indexes
Product Class CATVPMFilterWithParameter
Product.CATVPMFilter
|
+---CATVPMFilterWithParameter
public class CATVPMFilterWithParameter
Object to manage customer filter during the expand in PSN.
Notes:
Following convention is used for naming parameters.
Parameter names prefixed by:
- i are input parameters
- o are ouput parameters
- io are input/output parameters
Method Index
- o
EndExpand()
- Function called at the end of the expand
- o
Filter(CATVPMNode*,CATListOfCATVPMNode&,CATListOfCATVPMNode&,CATListOfCATVPMNode&,CATVPMError&)
- Function called during the expand to filter the childs of each nodes
- o
GetParameter()
- Function to get parameter from this filter
- o
SetParameter(char*)
- Function to set parameter on the filter
- o
StartExpand(SdaiEntityInstance*)
- Function called at the beginning of the expand
Methods
o EndExpand
| public virtual void EndExpand( | )const = 0 |
-
Function called at the end of the expand
o Filter
| public virtual void Filter( | CATVPMNode* | iFather, |
| const CATListOfCATVPMNode& | iProposedNodes, |
| CATListOfCATVPMNode& | oValid, |
| CATListOfCATVPMNode& | oNotValid, |
| CATVPMError& | oErr) const = 0 |
-
Function called during the expand to filter the childs of each nodes
- Parameters:
-
- iFather
- father node of childs to filter
- iProposedNodes
- child nodes to filter
- oValid
- valid nodes from iProposedNodes
- oNotValid
- not valid nodes from iProposedNodes
- oErr
- error during filter
Notes: if the severity of the error correspond to a warning (=0), the
associated message is displayed at the end of the expand ; if the severity
correspond to an error (>0), the associated message is displayed at the end
of the expand and the childs of iFather are collapsed
o GetParameter
| public virtual const char* GetParameter( | )const = 0 |
-
Function to get parameter from this filter
- Returns:
- parameter for the expand
o SetParameter
| public virtual void SetParameter( | const char* | iParameter) = 0 |
-
Function to set parameter on the filter
- Parameters:
-
- iParameter
- parameter for the expand
o StartExpand
| public virtual void StartExpand( | SdaiEntityInstance* | iPart) const = 0 |
-
Function called at the beginning of the expand
- Parameters:
-
- iPart
- root part for the expand
This object is included in the file: CATVPMFilterWithParameter.h
If needed, your Imakefile.mk should include the module: LV01FLTR