NXOpen .NET Reference  12.0.0
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.RuleManager Class Reference

Provides methods for manipulating the Knowledge Fusion rules in a part. More...

Inheritance diagram for NXOpen.RuleManager:

Classes

struct  _DebugInstance
 Used to return debug update information for instances.
 
struct  _DebugRule
 Used to return debug update information for rules.
 
struct  _FunctionArgumentsInformation
 Used to return information about the arguments for a function.
 
struct  _FunctionInformation
 Used to return information about a function.
 
struct  _ParameterRule
 Used to specify parameter values for child rule creation or modification.
 
struct  AdoptableTypes
 Used to return adoptable object types. More...
 
struct  DebugInstance
 Used to return debug update information for instances. More...
 
struct  DebugRule
 Used to return debug update information for rules. More...
 
struct  FunctionArgumentsInformation
 Used to return information about the arguments for a function. More...
 
struct  FunctionInformation
 Used to return information about a function. More...
 
struct  ParameterRule
 Used to specify parameter values for child rule creation or modification. More...
 

Public Types

enum  RuleType {
  Boolean, Frame, Integer, List,
  Name, Number, Point, String,
  Vector, Instance, Any, HostPointer
}
 Indicates the data type of a rule. More...
 
enum  LicenseType {
  NoLicense, Author, Execute, Pipeline,
  KfFeature, KfInterop, KfNewGeom, KfChecking
}
 Indicates the license type to be used. More...
 
enum  InitializationStatusType {
  Success, Failure, Unavailable, UnableToObtainLicense,
  CloseFailure
}
 Indicates the status from initializing RuleManager. More...
 
enum  Filter {
  User, System, Both, UserPlus,
  UserLoaded, SystemLoaded, BothLoaded, UserPlusLoaded
}
 The filter option for asking for classes. More...
 

Public Member Functions

unsafe
NXOpen.RuleManager.InitializationStatusType 
Initialize (NXOpen.RuleManager.LicenseType licenseToTake, out int intentStatus)
 Initialize the RuleManager. More...
 
unsafe void CreateDynamicRule (string referenceChain, string ruleName, NXOpen.RuleManager.RuleType ruleType, string ruleText)
 Create or modify a dynamic rule. More...
 
unsafe void CreateDynamicRule (string referenceChain, string ruleName, string behaviors, string ruleUnits, string ruleText, string leadingComment)
 Create or modify a dynamic rule. More...
 
unsafe void CreateDynamicRule (string referenceChain, string ruleName, string behaviors, string ruleText, string leadingComment)
 Create or modify a dynamic rule. More...
 
unsafe int DoKfUpdate (NXOpen.Session.UndoMarkId undoMark)
 Performs an KF update. More...
 
unsafe void DeleteDynamicRule (string referenceChain, string ruleName)
 Delete an existing dynamic rule. More...
 
unsafe void CreateChildRule (string ruleName, string className, NXOpen.RuleManager.ParameterRule[] parameters)
 Create a child rule and the root for this rule manager's part. More...
 
unsafe void DeleteChildRule (string ruleName)
 Delete a child rule from this rule manager. More...
 
unsafe void RemoveRuleOnly (string referenceChain)
 Remove a dynamic child or attribute rule, but leave the geometry. More...
 
unsafe bool IsUserClass (string className)
 Determine whether a class is a user class. More...
 
unsafe string[] GetRulesOfClass (string className)
 Get the names of all the rules defined in a class. More...
 
unsafe string[] GetDynamicRules (string childRuleName)
 Get the names of all dynamic rules defined on a child rule (or Root:). More...
 
unsafe string[] GetSpecifiedParameters (string referenceChain)
 Get the parameters that have been specified on a dynamic child rule. More...
 
unsafe string GetParameterFormula (string referenceChain, string parameterName)
 Get the formula for a parameter that has been specified on a dynamic child rule. More...
 
unsafe void Rename (string referenceChain, string newName)
 Rename a dynamic child or attribute rule. More...
 
unsafe void Copy (string oldNameChain, string oldLeafName, string newNameChain, string newLeafName)
 Copy a dynamic child or attribute rule. More...
 
unsafe string GetClass (string referenceChain)
 Get the class of a dynamic rule. More...
 
unsafe string[] GetClassesOfChildList (string referenceChain)
 Get the classes for the members of a child list rule. More...
 
unsafe string[] GetDependents (string referenceChain)
 Get the rules that depend on the specified dynamic rule. More...
 
unsafe string[] GetDependencies (string referenceChain)
 Get the rules that the specified dynamic rule depends on. More...
 
unsafe NXOpen.RuleManager.RuleType GetRuleType (string className, string ruleName)
 Get the type of a rule within a class. More...
 
unsafe NXOpen.RuleManager.RuleType GetRuleType (string referenceChain)
 Get the data type of a dynamic rule. More...
 
unsafe NXOpen.RuleManager.RuleType GetParameterType (string referenceChain)
 Get the type of a parameter in a dynamic child rule. More...
 
unsafe bool IsChildRule (string className, string ruleName)
 Returns whether a rule in a class is a child rule. More...
 
unsafe bool IsChildRule (string referenceChain)
 Returns whether a dynamic rule is a child rule. More...
 
unsafe bool IsChildList (string className, string ruleName)
 Returns whether a rule within a class is a child list rule. More...
 
unsafe bool IsChildList (string referenceChain)
 Returns whether a dynamic rule is a child list. More...
 
unsafe bool IsUncached (string className, string ruleName)
 Returns whether a rule within a class is uncached. More...
 
unsafe bool IsUncached (string referenceChain)
 Returns whether a dynamic rule is uncached. More...
 
unsafe bool IsHidden (string className, string ruleName)
 Returns whether a rule within a class is hidden. More...
 
unsafe bool IsHidden (string referenceChain)
 Returns whether a dynamic rule is hidden. More...
 
unsafe bool IsLocal (string className, string ruleName)
 Returns whether a rule within a class is local to that class. More...
 
unsafe bool IsParameter (string className, string ruleName)
 Returns whether a rule within a class is a parameter of that class. More...
 
unsafe bool IsCanonical (string className, string ruleName)
 Returns whether a rule within a class is canonical. More...
 
unsafe bool IsModifiable (string className, string ruleName)
 Returns whether a rule within a class is modifiable. More...
 
unsafe bool IsModifiable (string referenceChain)
 Returns whether a dynamic rule is modifiable. More...
 
unsafe bool IsMethod (string className, string ruleName)
 Returns whether a rule within a class is a method. More...
 
unsafe bool IsMethod (string referenceChain)
 Returns whether a dynamic rule is a method. More...
 
unsafe bool IsComputed (string referenceChain)
 Returns whether a dynamic rule's value has been computed yet. More...
 
unsafe void RebuildTrees ()
 Rebuilds the KF Navigator tree and any Part Inspector trees that are being shown. More...
 
unsafe bool IsRuleInClass (string className, string ruleName)
 Returns whether the rule is defined in the specified class. More...
 
unsafe string GetDefaultFormula (string className, string ruleName)
 Returns the default formula for a rule within a class . More...
 
unsafe Object Evaluate (string referenceChain)
 Evaluate a rule and return its value. More...
 
unsafe string EvaluateAsString (string referenceChain)
 Evaluate a rule and return its value as a string. More...
 
unsafe string EvaluateAnyAsString (string referenceChain)
 Evaluate a rule and return its value as a string. More...
 
unsafe string GetNameChain (NXOpen.NXObject ugObject)
 Returns the name chain More...
 
unsafe void RegenerateAll ()
 Regenerate all rules. More...
 
unsafe void SyntaxCheck (string fileName)
 Run the syntax check on a dfa file. More...
 
unsafe string[] GetAncestorClasses (string className)
 Get the ancestor classes for a given class. More...
 
unsafe void Reload (bool refreshUserClassDir)
 Reload all classes and functions. More...
 
unsafe void ReloadSingleClass (string className)
 Reload a single class. More...
 
unsafe void ReloadClassesAndFunctions (string[] classes, string[] functions)
 Reload specified classes and functions. More...
 
unsafe string[] GetRuleTypes ()
 Get strings that describe the rule types. More...
 
unsafe string[] GetClasses (NXOpen.RuleManager.Filter filter)
 Get class names that match the specified filter. More...
 
unsafe string[] GetFunctions (NXOpen.RuleManager.Filter filter, bool doSort)
 Get functions that match the specified filter. More...
 
unsafe void RemoveAllRules ()
 Remove all rules in the part. More...
 
unsafe string ReadDfaFile (string fileName)
 Read a dfa file and return its contents as a string. More...
 
unsafe void WriteDfaFile (string fileName, string fileString, bool replace)
 Write a string out to a dfa file. More...
 
unsafe string GetClassDfaFile (string className)
 Get the name of the dfa file that contains the specified class. More...
 
unsafe string[] GetLastError ()
 Get messages for the most recent error. More...
 
unsafe string GetReferenceText (NXOpen.NXObject ugObject)
 Get the text to use when referencing the specified ug object in a rule. More...
 
unsafe string GetObjectText (NXOpen.NXObject ugObject)
 Get the text to use when referencing the specified ug object in a rule. More...
 
unsafe bool AdoptObjects (NXOpen.NXObject[] ugObjects)
 Adopt the specified ug objects. More...
 
unsafe
NXOpen.RuleManager.AdoptableTypes[] 
GetAdoptableTypes ()
 The list of object types which can be adopted. More...
 
unsafe string GetRulesForObjects (NXOpen.NXObject[] ugObjects)
 Adoption text for the specified ug objects. More...
 
unsafe
NXOpen.RuleManager.FunctionInformation 
GetFunctionInformation (string functionName, string instanceOrClassName, bool isInstance, bool briefOnly)
 Get information about a function. More...
 
unsafe
NXOpen.RuleManager.FunctionArgumentsInformation[] 
GetFunctionArgumentsInformation (string functionName, string instanceOrClassName, bool isInstance, bool briefOnly)
 Get information about the arguments for a function. More...
 
unsafe string GetFunctionFile (string functionName)
 Get the file that contains the definitions for a function. More...
 
unsafe bool IsUserFunction (string functionName)
 Determine whether a function is one defined by the user. More...
 
unsafe bool IsExpressionRule (string ruleName)
 Determine whether a root level dynamic rule is mapped to an NX expression. More...
 
unsafe string GetDynamicRuleText (string referenceChain)
 Returns the rule text for a dynamic rule . More...
 
unsafe void GetDebugInstances (out NXOpen.RuleManager.DebugInstance[] instances, out NXOpen.RuleManager.DebugRule[] rules)
 Get the debug update instances. More...
 
unsafe int GetErrorStart ()
 Get the parse error start location. More...
 
unsafe int GetErrorEnd ()
 Get the parse error end location. More...
 
unsafe NXOpen.NXObject GetObjectOfInstance (string nameChain)
 Get object of instance More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe bool CreateMode [get]
 Returns the create mode flag. More...
 
unsafe bool DebugFlag [get, set]
 Returns or sets the debug update flag. More...
 

Detailed Description

Provides methods for manipulating the Knowledge Fusion rules in a part.

To obtain an instance of this class, refer to NXOpen.BasePart

Created in NX3.0.0

Member Enumeration Documentation

The filter option for asking for classes.

Enumerator
User 

User classes only

System 

System classes only

Both 

Both user and system classes

UserPlus 

User and application classes

UserLoaded 

User classes that are loaded

SystemLoaded 

System classes that are loaded

BothLoaded 

System and user classes that are loaded

UserPlusLoaded 

User and application classes that are loaded

Indicates the status from initializing RuleManager.

Enumerator
Success 

Initialization succeeded

Failure 

Initialization failed

Unavailable 

Intent not available

UnableToObtainLicense 

Cannot obtain license

CloseFailure 

Close failed

Indicates the license type to be used.

Enumerator
NoLicense 
Author 
Execute 
Pipeline 
KfFeature 
KfInterop 
KfNewGeom 
KfChecking 

Indicates the data type of a rule.

Enumerator
Boolean 
Frame 
Integer 
List 
Name 
Number 
Point 
String 
Vector 
Instance 
Any 
HostPointer 

Member Function Documentation

unsafe bool NXOpen.RuleManager.AdoptObjects ( NXOpen.NXObject[]  ugObjects)

Adopt the specified ug objects.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ugObjectsobjects to adopt
Returns
TRUE if update needs to be called
unsafe void NXOpen.RuleManager.Copy ( string  oldNameChain,
string  oldLeafName,
string  newNameChain,
string  newLeafName 
)

Copy a dynamic child or attribute rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
oldNameChainName chain for rule to copy
oldLeafNameLeaf name of rule to copy
newNameChainName chain for copied rule
newLeafNameLeaf name for copied rule
unsafe void NXOpen.RuleManager.CreateChildRule ( string  ruleName,
string  className,
NXOpen.RuleManager.ParameterRule[]  parameters 
)

Create a child rule and the root for this rule manager's part.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ruleNameName of child rule to create
classNameClass to instantiate as this child
parametersInput parameters for this class
unsafe void NXOpen.RuleManager.CreateDynamicRule ( string  referenceChain,
string  ruleName,
NXOpen.RuleManager.RuleType  ruleType,
string  ruleText 
)

Create or modify a dynamic rule.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for instance in which to create the dynamic rule
ruleNameName of rule to create
ruleTypeData type for the new rule
ruleTextValue for the new rule as a string
unsafe void NXOpen.RuleManager.CreateDynamicRule ( string  referenceChain,
string  ruleName,
string  behaviors,
string  ruleUnits,
string  ruleText,
string  leadingComment 
)

Create or modify a dynamic rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for instance in which to create the dynamic rule
ruleNameName of rule to create
behaviorsBehaviors for the new rule, for example, "Number Modifiable"
ruleUnitsUnit for the new rule, for example, "mm"
ruleTextValue for the new rule as a string
leadingCommentLeading comment of the form "#+ #-" for rule. This can be NULL
unsafe void NXOpen.RuleManager.CreateDynamicRule ( string  referenceChain,
string  ruleName,
string  behaviors,
string  ruleText,
string  leadingComment 
)

Create or modify a dynamic rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for instance in which to create the dynamic rule
ruleNameName of rule to create
behaviorsBehaviors for the new rule, for example, "Number Modifiable"
ruleTextValue for the new rule as a string
leadingCommentLeading comment of the form "#+ #-" for rule. This can be NULL
unsafe void NXOpen.RuleManager.DeleteChildRule ( string  ruleName)

Delete a child rule from this rule manager.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ruleNameName of child to delete
unsafe void NXOpen.RuleManager.DeleteDynamicRule ( string  referenceChain,
string  ruleName 
)

Delete an existing dynamic rule.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for instance from which to delete the dynamic rule
ruleNameName of rule to delete
unsafe int NXOpen.RuleManager.DoKfUpdate ( NXOpen.Session.UndoMarkId  undoMark)

Performs an KF update.

This ensures that all KF objects will be properly updated when created through dynamic rules.

Note: This method does the same thing as, Update.DoUpdate except that it does some addition updating to make sure CAE objects are complete.

Created in NX4.0.0

License requirements: None.

Parameters
undoMarkIf any update error occurs, the system will roll back to this undo mark.
Returns
The number of errors in the update module's error list. If errors occurred during update they will be added to that error list. To obtain a list of these errors, use Update.ErrorList
unsafe Object NXOpen.RuleManager.Evaluate ( string  referenceChain)

Evaluate a rule and return its value.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for the rule to evaluate
Returns
Value of the rule which may have one of many types depending on the rule type
unsafe string NXOpen.RuleManager.EvaluateAnyAsString ( string  referenceChain)

Evaluate a rule and return its value as a string.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for the rule to evaluate
Returns
Value of the rule formatted as a string
unsafe string NXOpen.RuleManager.EvaluateAsString ( string  referenceChain)

Evaluate a rule and return its value as a string.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for the rule to evaluate
Returns
Value of the rule formatted as a string
unsafe NXOpen.RuleManager.AdoptableTypes [] NXOpen.RuleManager.GetAdoptableTypes ( )

The list of object types which can be adopted.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Returns
Object type data
unsafe string [] NXOpen.RuleManager.GetAncestorClasses ( string  className)

Get the ancestor classes for a given class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameclass name for which to get component classes
Returns
names of ancestor classes
unsafe string NXOpen.RuleManager.GetClass ( string  referenceChain)

Get the class of a dynamic rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Class of rule
unsafe string NXOpen.RuleManager.GetClassDfaFile ( string  className)

Get the name of the dfa file that contains the specified class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
Returns
File name that contains the class
unsafe string [] NXOpen.RuleManager.GetClasses ( NXOpen.RuleManager.Filter  filter)

Get class names that match the specified filter.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
filterfilter for classes
Returns
class names
unsafe string [] NXOpen.RuleManager.GetClassesOfChildList ( string  referenceChain)

Get the classes for the members of a child list rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Classes for members of child list
unsafe void NXOpen.RuleManager.GetDebugInstances ( out NXOpen.RuleManager.DebugInstance[]  instances,
out NXOpen.RuleManager.DebugRule[]  rules 
)

Get the debug update instances.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
instancesArray of instances
rulesArray of rules
unsafe string NXOpen.RuleManager.GetDefaultFormula ( string  className,
string  ruleName 
)

Returns the default formula for a rule within a class .

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
The default formula for the rule
unsafe string [] NXOpen.RuleManager.GetDependencies ( string  referenceChain)

Get the rules that the specified dynamic rule depends on.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Reference chains for rules depending on the specified rule
unsafe string [] NXOpen.RuleManager.GetDependents ( string  referenceChain)

Get the rules that depend on the specified dynamic rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Reference chains for dependent rules
unsafe string [] NXOpen.RuleManager.GetDynamicRules ( string  childRuleName)

Get the names of all dynamic rules defined on a child rule (or Root:).

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
childRuleNamereference chain of child rule
Returns
Array of dynamic rule names in the child
unsafe string NXOpen.RuleManager.GetDynamicRuleText ( string  referenceChain)

Returns the rule text for a dynamic rule .

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainname chain for a dynamic rule
Returns
The text of the rule
unsafe int NXOpen.RuleManager.GetErrorEnd ( )

Get the parse error end location.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Returns
ending character pointer
unsafe int NXOpen.RuleManager.GetErrorStart ( )

Get the parse error start location.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Returns
starting character pointer
unsafe NXOpen.RuleManager.FunctionArgumentsInformation [] NXOpen.RuleManager.GetFunctionArgumentsInformation ( string  functionName,
string  instanceOrClassName,
bool  isInstance,
bool  briefOnly 
)

Get information about the arguments for a function.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
functionNameFunction name
instanceOrClassNameInstance or class name (used only for a method)
isInstanceTRUE if instance name passed, FALSE otherwise
briefOnlyTRUE if returning brief information only
Returns
Information about the function arguments
unsafe string NXOpen.RuleManager.GetFunctionFile ( string  functionName)

Get the file that contains the definitions for a function.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
functionNameFunction name
Returns
File where the function is defined
unsafe NXOpen.RuleManager.FunctionInformation NXOpen.RuleManager.GetFunctionInformation ( string  functionName,
string  instanceOrClassName,
bool  isInstance,
bool  briefOnly 
)

Get information about a function.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
functionNameFunction name
instanceOrClassNameInstance or class name (used only for a method otherwise null or Nothing
isInstanceTRUE if instance name passed, FALSE otherwise
briefOnlyTRUE if returning brief information only
Returns
Information about the function
unsafe string [] NXOpen.RuleManager.GetFunctions ( NXOpen.RuleManager.Filter  filter,
bool  doSort 
)

Get functions that match the specified filter.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
filterfilter for functions
doSortTRUE to get the functions sorted alphabetically
Returns
function names
unsafe string [] NXOpen.RuleManager.GetLastError ( )

Get messages for the most recent error.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Returns
lines for error messages
unsafe string NXOpen.RuleManager.GetNameChain ( NXOpen.NXObject  ugObject)

Returns the name chain

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ugObjectobject to find name chain
Returns
full name chain of the object
unsafe NXOpen.NXObject NXOpen.RuleManager.GetObjectOfInstance ( string  nameChain)

Get object of instance

Created in NX9.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
nameChainName chain of instance
Returns
object of instance
unsafe string NXOpen.RuleManager.GetObjectText ( NXOpen.NXObject  ugObject)

Get the text to use when referencing the specified ug object in a rule.

Created in NX8.5.0

License requirements: gateway ("UG GATEWAY")

Parameters
ugObjectobject to find object text for
Returns
Object text, either reference_chain or hostpointer text
unsafe string NXOpen.RuleManager.GetParameterFormula ( string  referenceChain,
string  parameterName 
)

Get the formula for a parameter that has been specified on a dynamic child rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
parameterNameParameter name
Returns
Formula for the specified parameter
unsafe NXOpen.RuleManager.RuleType NXOpen.RuleManager.GetParameterType ( string  referenceChain)

Get the type of a parameter in a dynamic child rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Data type required for this rule
unsafe string NXOpen.RuleManager.GetReferenceText ( NXOpen.NXObject  ugObject)

Get the text to use when referencing the specified ug object in a rule.

Note that the rule text may reference the container object rather than the given object. For example, the rule text may reference the owning CSYS feature rather than the given datum plane or datum axis. If the rule text of the given object is desired then call RuleManager.GetObjectText .

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ugObjectobject to find reference text for
Returns
Reference text, either reference_chain or hostpointer text
unsafe string NXOpen.RuleManager.GetRulesForObjects ( NXOpen.NXObject[]  ugObjects)

Adoption text for the specified ug objects.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ugObjectsobjects to adopt
Returns
Output text for the objects
unsafe string [] NXOpen.RuleManager.GetRulesOfClass ( string  className)

Get the names of all the rules defined in a class.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
Returns
Array of names of rules in the class
unsafe NXOpen.RuleManager.RuleType NXOpen.RuleManager.GetRuleType ( string  className,
string  ruleName 
)

Get the type of a rule within a class.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
Data type required for this rule
unsafe NXOpen.RuleManager.RuleType NXOpen.RuleManager.GetRuleType ( string  referenceChain)

Get the data type of a dynamic rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Data type of the rule
unsafe string [] NXOpen.RuleManager.GetRuleTypes ( )

Get strings that describe the rule types.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Returns
strings for rule types
unsafe string [] NXOpen.RuleManager.GetSpecifiedParameters ( string  referenceChain)

Get the parameters that have been specified on a dynamic child rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
Array of names of parameters specified
unsafe NXOpen.RuleManager.InitializationStatusType NXOpen.RuleManager.Initialize ( NXOpen.RuleManager.LicenseType  licenseToTake,
out int  intentStatus 
)

Initialize the RuleManager.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
licenseToTakeWhich license to take
intentStatusStatus from initializing subsystem
Returns
Status from initializing RuleManager
unsafe bool NXOpen.RuleManager.IsCanonical ( string  className,
string  ruleName 
)

Returns whether a rule within a class is canonical.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is canonical
unsafe bool NXOpen.RuleManager.IsChildList ( string  className,
string  ruleName 
)

Returns whether a rule within a class is a child list rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is a child list rule
unsafe bool NXOpen.RuleManager.IsChildList ( string  referenceChain)

Returns whether a dynamic rule is a child list.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is a child list
unsafe bool NXOpen.RuleManager.IsChildRule ( string  className,
string  ruleName 
)

Returns whether a rule in a class is a child rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is a child rule
unsafe bool NXOpen.RuleManager.IsChildRule ( string  referenceChain)

Returns whether a dynamic rule is a child rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is a child rule
unsafe bool NXOpen.RuleManager.IsComputed ( string  referenceChain)

Returns whether a dynamic rule's value has been computed yet.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule's value has been computed
unsafe bool NXOpen.RuleManager.IsExpressionRule ( string  ruleName)

Determine whether a root level dynamic rule is mapped to an NX expression.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
ruleNameDynamic rule name
Returns
True if the rule is an NX expression
unsafe bool NXOpen.RuleManager.IsHidden ( string  className,
string  ruleName 
)

Returns whether a rule within a class is hidden.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is hidden
unsafe bool NXOpen.RuleManager.IsHidden ( string  referenceChain)

Returns whether a dynamic rule is hidden.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is hidden
unsafe bool NXOpen.RuleManager.IsLocal ( string  className,
string  ruleName 
)

Returns whether a rule within a class is local to that class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is local to the class
unsafe bool NXOpen.RuleManager.IsMethod ( string  className,
string  ruleName 
)

Returns whether a rule within a class is a method.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is a method
unsafe bool NXOpen.RuleManager.IsMethod ( string  referenceChain)

Returns whether a dynamic rule is a method.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is a method
unsafe bool NXOpen.RuleManager.IsModifiable ( string  className,
string  ruleName 
)

Returns whether a rule within a class is modifiable.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is modifiable
unsafe bool NXOpen.RuleManager.IsModifiable ( string  referenceChain)

Returns whether a dynamic rule is modifiable.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is modifiable
unsafe bool NXOpen.RuleManager.IsParameter ( string  className,
string  ruleName 
)

Returns whether a rule within a class is a parameter of that class.

Created in NX3.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is a parameter of the class
unsafe bool NXOpen.RuleManager.IsRuleInClass ( string  className,
string  ruleName 
)

Returns whether the rule is defined in the specified class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is defined in the class
unsafe bool NXOpen.RuleManager.IsUncached ( string  className,
string  ruleName 
)

Returns whether a rule within a class is uncached.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
ruleNameRule name within the class
Returns
True if the rule is uncached
unsafe bool NXOpen.RuleManager.IsUncached ( string  referenceChain)

Returns whether a dynamic rule is uncached.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule
Returns
True if the rule is uncached
unsafe bool NXOpen.RuleManager.IsUserClass ( string  className)

Determine whether a class is a user class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameClass name
Returns
True if the class is a user class
unsafe bool NXOpen.RuleManager.IsUserFunction ( string  functionName)

Determine whether a function is one defined by the user.

Created in NX5.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
functionNameFunction name
Returns
True if the class is a user function
unsafe string NXOpen.RuleManager.ReadDfaFile ( string  fileName)

Read a dfa file and return its contents as a string.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
fileNameFile name to read
Returns
Contents of the file formatted as a string
unsafe void NXOpen.RuleManager.RebuildTrees ( )

Rebuilds the KF Navigator tree and any Part Inspector trees that are being shown.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

unsafe void NXOpen.RuleManager.RegenerateAll ( )

Regenerate all rules.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

unsafe void NXOpen.RuleManager.Reload ( bool  refreshUserClassDir)

Reload all classes and functions.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
refreshUserClassDirflag for whether to refresh search dirs after load
unsafe void NXOpen.RuleManager.ReloadClassesAndFunctions ( string[]  classes,
string[]  functions 
)

Reload specified classes and functions.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classesnames of classes to reload
functionsnames of functions to reload
unsafe void NXOpen.RuleManager.ReloadSingleClass ( string  className)

Reload a single class.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
classNameclass name to reload
unsafe void NXOpen.RuleManager.RemoveAllRules ( )

Remove all rules in the part.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

unsafe void NXOpen.RuleManager.RemoveRuleOnly ( string  referenceChain)

Remove a dynamic child or attribute rule, but leave the geometry.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule to remove
unsafe void NXOpen.RuleManager.Rename ( string  referenceChain,
string  newName 
)

Rename a dynamic child or attribute rule.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
referenceChainReference chain for rule to rename
newNameNew leaf name
unsafe void NXOpen.RuleManager.SyntaxCheck ( string  fileName)

Run the syntax check on a dfa file.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
fileNamedfa file to check
unsafe void NXOpen.RuleManager.WriteDfaFile ( string  fileName,
string  fileString,
bool  replace 
)

Write a string out to a dfa file.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters
fileNameFile name to write
fileStringString to write to file
replaceif TRUE, replace the file if it exists

Property Documentation

unsafe bool NXOpen.RuleManager.CreateMode
get

Returns the create mode flag.

Created in NX5.0.0

License requirements: None.

unsafe bool NXOpen.RuleManager.DebugFlag
getset

Returns or sets the debug update flag.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: gateway ("UG GATEWAY")

Tag NXOpen.RuleManager.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.