Glyph Version 7.22.2 |
pw:: RuleRule type Derives FromSummary
create
This action creates a new rule object. ParametersNone ReturnsThis action returns a new pw::Rule object. getAll
This action gets a list of all of the current rules. ParametersNone ReturnsThis action returns a list of pw::Rule objects. getAllowableEntityTypes
This action gets a list of allowable entity types supported by the specified function. Parameters
ReturnsThis action returns a list of strings representing the supported entity types. getFunctionNames
This action gets a list of allowable function names. ParametersNone ReturnsThis action returns a list of strings representing the supported function names. setViolationLimit
This attribute is the maximum number of cell or point locations that will be reported in violation of any rule. This does not affect the count reported by getEntityViolations. It only affects the number of actual locations reported. TypeThis attribute is a integer with range [1, infinity) Default1000 Global
This attribute controls whether the rule is a global rule. TypeThis attribute is a boolean, with true meaning that rule is global. DefaultThe default value for this attribute is false. InformationIf a global rule has this attribute set to false, the rule will retain the current entities but will not be automatically updated with any future entities, although they can still be added manually. A non-global rule cannot be made global if the function is not defined. Description
This attribute is a description of the rule. TypeThis attribute is a string. DefaultThe default value for this attribute is generated based on the type of rule created. Color
This attribute is the color of the rule. TypeThis attribute is a color. DefaultThe default value of this attribute is 0x00ff0000. Visibility
This attribute controls whether rule violations are displayed. TypeThis attribute is a boolean value, with true meaning that element violations will be displayed. DefaultThe default for this attribute is true. isDefaultDescription
This action checks to see if the description is the default description. ParametersNone ReturnsThis action returns a boolean, which is true if the rule’s description is the default value, false if the description has been set by the user. setCriterion
This action sets the measurement to be used, the comparison operand, and the limit to check. Parameters
ReturnsThis action returns boolean, which is true if the criterion was successfully set. add
This action adds an entity to the rule. Parameters
ReturnsThis action returns boolean, which is true if the entity was successfully added. remove
This action removes an entity from the rule (can only call for non-global rules). Parameters
ReturnsThis action returns boolean, which is true if the entity was successfully removed. contains
This action checks to see if a rule contains a specified entity. Parameters
ReturnsThis action returns boolean, which is true if the entity is monitored by the rule. getEntityCount
This action gets the number of entities monitored by the rule and optionally gets the list of entities. Parameters
ReturnsThis action returns the integer number of entities. getOutdatedEntityCount
This action gets the number of outdated entities monitored by the rule and optionally gets the list of entities. Outdated entities are entities that have had their points modified since the last rule evaluation. Parameters
ReturnsThis action returns the integer number of outdated entities. getFailingEntityCount
This action gets the number of failing entities monitored by the rule and optionally gets the list of entities. Failing entities are entities that had cells or points that violated the rule at the time of the last rule evaluation. Parameters
ReturnsThis action returns the integer number of failing entities. getEntityViolations
This action gets the number of rule violations for a specific entity. It returns the total count, regardless of the value set by setViolationLimit. Optionally, a list of the cell or points violating the rule can be retrieved. This list is limited by the number specified with setViolationLimit. Parameters
ReturnsThis action returns the integer number of rule violations. getAllowableEntityTypes
This action gets a list of allowable entity types currently supported by the rule based on the specified criterion and any entities already added. ParametersNOne ReturnsThis action returns a list of strings representing the supported entity types. |
This action creates a new rule object.
pw::Rule create
This action gets a list of all of the current rules.
pw::Rule getAll
This action gets a list of allowable entity types supported by the specified function.
pw::Rule getAllowableEntityTypes function
This action gets a list of allowable function names.
pw::Rule getFunctionNames
This attribute is the maximum number of cell or point locations that will be reported in violation of any rule.
pw::Rule get/setViolationLimit limit
This attribute controls whether the rule is a global rule.
$rule get/setGlobal global
This attribute is a description of the rule.
$rule get/setDescription description
This attribute is the color of the rule.
$rule get/setColor color
This attribute controls whether rule violations are displayed.
$rule get/setVisibility value
This action deletes this rule.
$rule delete
This action checks to see if the description is the default description.
$rule isDefaultDescription
This action sets the measurement to be used, the comparison operand, and the limit to check.
$rule setCriterion function operand limit
This action gets the measurement to used, the comparison operand, and the limit being checked.
$rule getCriterion
This action adds an entity to the rule.
$rule add entity
This action removes an entity from the rule (can only call for non-global rules).
$rule remove entity
This action checks to see if a rule contains a specified entity.
$rule contains entity
This action gets the number of entities monitored by the rule and optionally gets the list of entities.
$rule getEntityCount ?-entities entsVar?
This action gets the number of outdated entities monitored by the rule and optionally gets the list of entities.
$rule getOutdatedEntityCount ?-entities entsVar?
This action gets the number of failing entities monitored by the rule and optionally gets the list of entities.
$rule getFailingEntityCount ?-entities entsVar?
This action evaluates any assigned entities that have not been evaluated or that have changed since the last evaluation.
$rule evaluate
This action gets the number of rule violations for a specific entity.
$rule getEntityViolations ?-locations locationsVar? ?-percent percentVar? entity
This action resets the criterion and removes all entities from the rule.
$rule reset