Type for filtering examine results
pw:: | Type for filtering examine results |
Static Actions | |
create | This action creates a new examine filter object. |
getAll | This action gets a list of all of the current filters. |
getByName | This action gets an examine filter object with the given name. |
Instance Attributes | |
Name | This attribute is the name of the examine filter. |
FilterType | This attribute is the type of the examine filter. |
Instance Actions | |
getLineCount | This action gets the number of lines that defines the filter |
getLineType | This action gets the type of a line in the filter |
getLine | This action gets the filter line at the given index. |
setDecisionLine | This action sets the filter decision type at the given index. |
setConditionLine | This action sets the filter condition attribute, operand and value at the given index. |
insertDecisionLine | This action inserts a decision filter line before the line with the given index. |
insertConditionLine | This action inserts a condition filter line before the line with the given index. |
removeLine | This action removes a filter line at the given index including any children lines if the type of the line is DecisionBegin or DecisionEnd. |
removeAllLines | This action removes all filter lines from the filter. |
getEnabled | This action returns whether the line at the given index is enabled. |
setEnabled | This action sets the enabled state of the line at the given index. |
delete | This action deletes this examine filter. |
pw::ExamineFilter create
This action creates a new examine filter object.
This action has no parameters.
This action returns a new pw::ExamineFilter object.
pw::ExamineFilter getAll
This action gets a list of all of the current filters.
This action has no parameters.
This action returns a list of pw::ExamineFilter objects.
pw::ExamineFilter getByName name
This action gets an examine filter object with the given name.
name | This parameter is the string name of the examine filter to get. |
This action returns a pw::ExamineFilter object.
$filter get/setName name
This attribute is the name of the examine filter.
This attribute is a string.
The default for this attribute is a uniquely generated name.
$filter get/setFilterType type
This attribute is the type of the examine filter.
This attribute is a string with valid values < Grid | Overset >.
The default for this attribute is Grid
$filter getLineCount
This action gets the number of lines that defines the filter
This action has no parameters.
This action returns the integer count of lines in the filter.
$filter getLine index
This action gets the filter line at the given index.
index | This parameter is the integer index of the line to get with the range [1, number of lines]. |
If the line type of this line is Condition, this action will return a list of three values corresponding to the attribute, operand, and the value. If the line type of this line is DecisionBegin or DecisionEnd, this action will return a list of one value corresponding to the type of decision.
$filter setDecisionLine index type
This action sets the filter decision type at the given index.
index | This parameter is the integer index of the line to set with the range [1, number of lines]. If the number of lines is 0 and this parameter is 1, this action will add a decision line in the first position, otherwise if the index refers to a line whose type is not DecisionBegin or DecisionEnd an error will occur. |
type | This parameter is the string type of the decision with valid values < All | Any | None >. |
This action does not return anything.
$filter setConditionLine index attribute operand value
This action sets the filter condition attribute, operand and value at the given index.
index | This parameter is the integer index of the line to set with the range [1, number of lines]. If the number of lines is 0 and this parameter is 1, this action will add a condition line in the first position, otherwise if the index refers to a line whose type is not Condition an error will occur. |
attribute | This parameter is the string attribute of the condition to set the line to. Syntactically, any string is valid, but in order for the filter to be applied during examine, the attribute should be a string returned from pw::Examine.getFunctionNames, which is applicable for the entity being examined. |
operand | This parameter is the string operand of the condition to set the line to. Valid values are < Equal | NotEqual | LessThan | LessThanEqual | GreaterThan | GreaterThanEqual | InRange | OutOfRange | Largest | Smallest | Contains | Regex | Glob > |
value | This parameter is the string value of the condition to set the line to. |
This action does not return anything.
$filter insertDecisionLine index type
This action inserts a decision filter line before the line with the given index.
index | This parameter is the integer index of the line to insert before with the range [1, number of lines]. |
type | This parameter is the string type of the decision with valid values < All | Any | None >. |
This action does not return anything.
$filter insertConditionLine index attribute operand value
This action inserts a condition filter line before the line with the given index.
index | This parameter is the integer index of the line to insert before with the range [1, number of lines]. |
attribute | This parameter is the string attribute of the condition to insert. |
operand | This parameter is the string operand of the condition to insert. |
value | This parameter is the string value of the condition to insert. |
This action does not return anything.
$filter removeLine index
This action removes a filter line at the given index including any children lines if the type of the line is DecisionBegin or DecisionEnd.
index | This parameter is the integer index of the line to remove with the range [1, number of lines]. |
This action does not return anything.
$filter setEnabled index enabled
This action sets the enabled state of the line at the given index.
index | This parameter is the integer index of the line to set the enabled state of, with the range [1, number of lines]. |
enabled | This is the boolean enabled state. |
This action does not return anything.
This action creates a new examine filter object.
pw::ExamineFilter create
This action gets a list of all of the current filters.
pw::ExamineFilter getAll
This action gets an examine filter object with the given name.
pw::ExamineFilter getByName name
This attribute is the name of the examine filter.
$filter get/setName name
This attribute is the type of the examine filter.
$filter get/setFilterType type
This action gets the number of lines that defines the filter
$filter getLineCount
This action gets the type of a line in the filter
$filter getLineType index
This action gets the filter line at the given index.
$filter getLine index
This action sets the filter decision type at the given index.
$filter setDecisionLine index type
This action sets the filter condition attribute, operand and value at the given index.
$filter setConditionLine index attribute operand value
This action inserts a decision filter line before the line with the given index.
$filter insertDecisionLine index type
This action inserts a condition filter line before the line with the given index.
$filter insertConditionLine index attribute operand value
This action removes a filter line at the given index including any children lines if the type of the line is DecisionBegin or DecisionEnd.
$filter removeLine index
This action removes all filter lines from the filter.
$filter removeAllLines
This action returns whether the line at the given index is enabled.
$filter getEnabled index
This action sets the enabled state of the line at the given index.
$filter setEnabled index enabled
This action deletes this examine filter.
$filter delete
This action gets a list of allowable function names.
pw::Examine getFunctionNames