vcProductFilter

vcProductFilter is a base class for all product filters. A product filter determines if a particular product instance is accepted or not.

Properties

Name Type Access Description
Name String RW Filter name
IsEnabled Boolean RW

When set to true, the filter will be active.
When set to false, the filter will accept any product.
Owner vcStatement or vcProductTypeAssemblyPatternItem R Gets filter owner

ExpressionFilter Properties

Name Type Access Description
ProductAccessor String RW Product name accessor
Expression String RW Expression to compare against
FilterDiagnosticsMode Enumeration RW

Print additional diagnostic messages if product is not matched by filter.

See FilterDiagnosticsMode constants for more information.

ProductPropertyFilter Properties

Name Type Access Description
TargetProperty String RW Target property name
Operator Enumeration RW

Comparison operation.

See Boolean Comparison Operator constants for more information.
ComparisonValue String RW Value to compare against
FilterDiagnosticsMode Enumeration RW

Print additional diagnostic messages if product is not matched by filter.

See FilterDiagnosticsMode constants for more information.

SpecificProductFilter Properties

Name Type Access Description
ProductVariableName String RW Product variable name
CompareMode Enumeration RW

Comparison mode – used only when product variable is a list.

See CompareMode constants for more information.

Methods

Name Return Type Parameters Description
acceptsProduct Boolean vcProduct product Tests the given product instance against the filter.    Returns True if the product instance passes the filter.    Throws an error if the product is None.
reset None None Resets filter
createProperty vcProperty Enumeration type, String name Creates property
deleteProperty None vcProperty Deletes property
getProperty vcProperty String name Gets property
getComponent vcNode None Returns the component if the filter is in a statement/process