Glyph
Version 7.22.2
About
Base Type
Global Types
General Types
Mode Types
Base Entity Type
Database Entity Types
Grid Entity Types
Source Entity Types
Segment Types
Connector Support Types
Domain Support Types
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: ExamineFilter

Type for filtering examine results

Derives From

pw::Object

Summary
pw:: ExamineFilter
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.

Static Actions

create

pw::ExamineFilter create

This action creates a new examine filter object.

Parameters

This action has no parameters.

Returns

This action returns a new pw::ExamineFilter object.

getAll

pw::ExamineFilter getAll

This action gets a list of all of the current filters.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::ExamineFilter objects.

getByName

pw::ExamineFilter getByName name

This action gets an examine filter object with the given name.

Parameters

nameThis parameter is the string name of the examine filter to get.

Returns

This action returns a pw::ExamineFilter object.

Instance Attributes

Name

$filter get/setName name

This attribute is the name of the examine filter.

Type

This attribute is a string.

Default

The default for this attribute is a uniquely generated name.

FilterType

$filter get/setFilterType type

This attribute is the type of the examine filter.

Type

This attribute is a string with valid values < Grid | Overset >.

Default

The default for this attribute is Grid

Instance Actions

getLineCount

$filter getLineCount

This action gets the number of lines that defines the filter

Parameters

This action has no parameters.

Returns

This action returns the integer count of lines in the filter.

getLineType

$filter getLineType index

This action gets the type of a line in the filter

Parameters

indexThis parameter is the integer index of the line to get the type of, with the valid range being [1, number of lines]

Returns

This action returns a string with values < Condition | DecisionBegin | DecisionEnd >.

getLine

$filter getLine index

This action gets the filter line at the given index.

Parameters

indexThis parameter is the integer index of the line to get with the range [1, number of lines].

Returns

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.

setDecisionLine

$filter setDecisionLine index type

This action sets the filter decision type at the given index.

Parameters

indexThis 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.
typeThis parameter is the string type of the decision with valid values < All | Any | None >.

Returns

This action does not return anything.

setConditionLine

$filter setConditionLine index attribute operand value

This action sets the filter condition attribute, operand and value at the given index.

Parameters

indexThis 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.
attributeThis 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.
operandThis 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 >
valueThis parameter is the string value of the condition to set the line to.

Returns

This action does not return anything.

insertDecisionLine

$filter insertDecisionLine index type

This action inserts a decision filter line before the line with the given index.

Parameters

indexThis parameter is the integer index of the line to insert before with the range [1, number of lines].
typeThis parameter is the string type of the decision with valid values < All | Any | None >.

Returns

This action does not return anything.

insertConditionLine

$filter insertConditionLine index attribute operand value

This action inserts a condition filter line before the line with the given index.

Parameters

indexThis parameter is the integer index of the line to insert before with the range [1, number of lines].
attributeThis parameter is the string attribute of the condition to insert.
operandThis parameter is the string operand of the condition to insert.
valueThis parameter is the string value of the condition to insert.

Returns

This action does not return anything.

removeLine

$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.

Parameters

indexThis parameter is the integer index of the line to remove with the range [1, number of lines].

Returns

This action does not return anything.

removeAllLines

$filter removeAllLines

This action removes all filter lines from the filter.

Parameters

None

Returns

This action does not return anything.

getEnabled

$filter getEnabled index

This action returns whether the line at the given index is enabled.

Parameters

indexThis parameter is the integer index of the line to check if it is enabled with the range [1, number of lines].

Returns

This action returns the boolean enabled state of the line.

setEnabled

$filter setEnabled index enabled

This action sets the enabled state of the line at the given index.

Parameters

indexThis parameter is the integer index of the line to set the enabled state of, with the range [1, number of lines].
enabledThis is the boolean enabled state.

Returns

This action does not return anything.

delete

$filter delete

This action deletes this examine filter.

Parameters

This action has no parameters.

Returns

This action returns nothing.
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
pw::ExamineFilter create
This action creates a new examine filter object.
pw::ExamineFilter getAll
This action gets a list of all of the current filters.
pw::ExamineFilter getByName name
This action gets an examine filter object with the given name.
$filter get/setName name
This attribute is the name of the examine filter.
$filter get/setFilterType type
This attribute is the type of the examine filter.
$filter getLineCount
This action gets the number of lines that defines the filter
$filter getLineType index
This action gets the type of a line in the filter
$filter getLine index
This action gets the filter line at the given index.
$filter setDecisionLine index type
This action sets the filter decision type at the given index.
$filter setConditionLine index attribute operand value
This action sets the filter condition attribute, operand and value at the given index.
$filter insertDecisionLine index type
This action inserts a decision filter line before the line with the given index.
$filter insertConditionLine index attribute operand value
This action inserts a condition filter line before the line with the given index.
$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.
$filter removeAllLines
This action removes all filter lines from the filter.
$filter getEnabled index
This action returns whether the line at the given index is enabled.
$filter setEnabled index enabled
This action sets the enabled state of the line at the given index.
$filter delete
This action deletes this examine filter.
Base type for all glyph types
Type for filtering examine results
A string is an array of characters.
An integer is a whole number.
pw::Examine getFunctionNames
This action gets a list of allowable function names.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.