K4 Base Library   K4 Rule Objects
Copyright © 2021 by K4.org
  (v.0.48.124)

Hierarchy

Index

Properties

Properties

Readonly allDesignRules

allDesignRules: function

R.reflect.allDesignRules(designName) => RuleDescriptor[]

Returns a list of RuleDescriptors for all rules on the given Design.

param

The name (string) of the design.

returns

An array of RuleDescriptors for the rules on designName.

example

R.reflect.allDesignRules('MyHouse')

Readonly allModelRules

allModelRules: function

R.reflect.allModelRules(model) => RuleDescriptor[]

Returns a list of RuleDescriptors for all model rules in the given instance.

param

The model to scan.

returns

An array of RuleDescriptors for the model rules on model.

example

R.reflect.allModelRules(R.rootModel)

Readonly allRules

allRules: function

R.reflect.allRules(model) => RuleDescriptor[]

Returns a list of RuleDescriptors for all rules (Design and Model) on the given instance.

param

The model to scan.

returns

An array of RuleDescriptors for all rules on model.

example

R.reflect.allRules(R.rootModel)

Readonly designIsKindOf

designIsKindOf: function

R.reflect.designIsKindOf(designA, designB) => boolean

Returns true if designA mixes in (directly or recursively) designB

param

The name (string) of the design to check.

param

The name (string) of the potential candidate design.

returns

True if designA is derived from designB.

example

R.reflect.designIsKindOf('BaseAssembly', 'FrameMixin')

Readonly getDesignDescriptor

getDesignDescriptor: function

R.reflect.getDesignDescriptor(designName) => DesignDescriptor

Returns the DesignDescriptor of the given design.

param

The name (string) of the design

returns

A DesignDescriptor or undefined if the design cannot be found.

example

R.reflect.getDesignDescriptor('ButterflyValve')

Readonly getDesignRuleDescriptor

getDesignRuleDescriptor: function

R.reflect.getDesignRuleDescriptor(designName, ruleName) => RuleDescriptor

Return the RuleDescriptor of the given Design rule. This will be the same as R.reflect.getRuleDescriptor unless ruleName has been overridden.

param

The name of the Design which owns the rule

param

The name (string) of the rule

returns

A RuleDescriptor or undefined if the Design or Rule does not exist.

example

R.reflect.getDesignRuleDescriptor("PressurePipe", 'bottomFlangeDiameter')

Readonly getRuleDescriptor

getRuleDescriptor: function

R.reflect.getRuleDescriptor(model, ruleName) => RuleDescriptor

Return the RuleDescriptor of the given rule.

param

The instance on which the rule resides

param

The name (string) of the rule

returns

A RuleDescriptor or undefined if the rule does not exist.

example

R.reflect.getRuleDescriptor(this, 'bottomFlangeDiameter')

Readonly isModelRule

isModelRule: function

R.reflect.isModelRule(model, ruleName) => boolean

Returns true iff ruleName is a model rule on model. Note that this, like all "reflect" methods, does not create a dependency on model.ruleName.

param

The instance on which the rule resides

param

The name of the rule as a string.

returns

True if the rule is a model rule, not a design rule.

example

R.reflect.isModelRule(this, "size")