Class RuleManager

Inheritance
System.Object
System.MarshalByRefObject
NXRemotableObject
RuleManager
Implements
System.Runtime.Remoting.Messaging.IMessageSink
Inherited Members
System.MarshalByRefObject.CreateObjRef(System.Type)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NXOpen
Assembly: NXOpen.dll
Syntax
public class RuleManager : NXRemotableObject, IMessageSink

Constructors

RuleManager(BasePart)

Declaration
protected RuleManager(BasePart owner)
Parameters
Type Name Description
BasePart owner

Properties

CreateMode

Declaration
public bool CreateMode { get; }
Property Value
Type Description
System.Boolean

DebugFlag

Declaration
public bool DebugFlag { get; set; }
Property Value
Type Description
System.Boolean

Tag

Declaration
public Tag Tag { get; }
Property Value
Type Description
Tag

Methods

AdoptObjects(NXObject[])

Declaration
public bool AdoptObjects(NXObject[] ugObjects)
Parameters
Type Name Description
NXObject[] ugObjects
Returns
Type Description
System.Boolean

Copy(String, String, String, String)

Declaration
public void Copy(string oldNameChain, string oldLeafName, string newNameChain, string newLeafName)
Parameters
Type Name Description
System.String oldNameChain
System.String oldLeafName
System.String newNameChain
System.String newLeafName

CreateChildRule(String, String, RuleManager.ParameterRule[])

Declaration
public void CreateChildRule(string ruleName, string className, RuleManager.ParameterRule[] parameters)
Parameters
Type Name Description
System.String ruleName
System.String className
RuleManager.ParameterRule[] parameters

CreateDynamicRule(String, String, RuleManager.RuleType, String)

Declaration
public void CreateDynamicRule(string referenceChain, string ruleName, RuleManager.RuleType ruleType, string ruleText)
Parameters
Type Name Description
System.String referenceChain
System.String ruleName
RuleManager.RuleType ruleType
System.String ruleText

CreateDynamicRule(String, String, String, String, String)

Declaration
public void CreateDynamicRule(string referenceChain, string ruleName, string behaviors, string ruleText, string leadingComment)
Parameters
Type Name Description
System.String referenceChain
System.String ruleName
System.String behaviors
System.String ruleText
System.String leadingComment

CreateDynamicRule(String, String, String, String, String, String)

Declaration
public void CreateDynamicRule(string referenceChain, string ruleName, string behaviors, string ruleUnits, string ruleText, string leadingComment)
Parameters
Type Name Description
System.String referenceChain
System.String ruleName
System.String behaviors
System.String ruleUnits
System.String ruleText
System.String leadingComment

DeleteChildRule(String)

Declaration
public void DeleteChildRule(string ruleName)
Parameters
Type Name Description
System.String ruleName

DeleteDynamicRule(String, String)

Declaration
public void DeleteDynamicRule(string referenceChain, string ruleName)
Parameters
Type Name Description
System.String referenceChain
System.String ruleName

DoKfUpdate(Session.UndoMarkId)

Declaration
public int DoKfUpdate(Session.UndoMarkId undoMark)
Parameters
Type Name Description
Session.UndoMarkId undoMark
Returns
Type Description
System.Int32

Evaluate(String)

Declaration
public object Evaluate(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Object

EvaluateAnyAsString(String)

Declaration
public string EvaluateAnyAsString(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String

EvaluateAsString(String)

Declaration
public string EvaluateAsString(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String

GetAdoptableTypes()

Declaration
public RuleManager.AdoptableTypes[] GetAdoptableTypes()
Returns
Type Description
RuleManager.AdoptableTypes[]

GetAncestorClasses(String)

Declaration
public string[] GetAncestorClasses(string className)
Parameters
Type Name Description
System.String className
Returns
Type Description
System.String[]

GetClass(String)

Declaration
public string GetClass(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String

GetClassDfaFile(String)

Declaration
public string GetClassDfaFile(string className)
Parameters
Type Name Description
System.String className
Returns
Type Description
System.String

GetClasses(RuleManager.Filter)

Declaration
public string[] GetClasses(RuleManager.Filter filter)
Parameters
Type Name Description
RuleManager.Filter filter
Returns
Type Description
System.String[]

GetClassesOfChildList(String)

Declaration
public string[] GetClassesOfChildList(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String[]

GetDebugInstances(out RuleManager.DebugInstance[], out RuleManager.DebugRule[])

Declaration
public void GetDebugInstances(out RuleManager.DebugInstance[] instances, out RuleManager.DebugRule[] rules)
Parameters
Type Name Description
RuleManager.DebugInstance[] instances
RuleManager.DebugRule[] rules

GetDefaultFormula(String, String)

Declaration
public string GetDefaultFormula(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.String

GetDependencies(String)

Declaration
public string[] GetDependencies(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String[]

GetDependents(String)

Declaration
public string[] GetDependents(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String[]

GetDynamicRules(String)

Declaration
public string[] GetDynamicRules(string childRuleName)
Parameters
Type Name Description
System.String childRuleName
Returns
Type Description
System.String[]

GetDynamicRuleText(String)

Declaration
public string GetDynamicRuleText(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String

GetErrorEnd()

Declaration
public int GetErrorEnd()
Returns
Type Description
System.Int32

GetErrorStart()

Declaration
public int GetErrorStart()
Returns
Type Description
System.Int32

GetFunctionArgumentsInformation(String, String, Boolean, Boolean)

Declaration
public RuleManager.FunctionArgumentsInformation[] GetFunctionArgumentsInformation(string functionName, string instanceOrClassName, bool isInstance, bool briefOnly)
Parameters
Type Name Description
System.String functionName
System.String instanceOrClassName
System.Boolean isInstance
System.Boolean briefOnly
Returns
Type Description
RuleManager.FunctionArgumentsInformation[]

GetFunctionFile(String)

Declaration
public string GetFunctionFile(string functionName)
Parameters
Type Name Description
System.String functionName
Returns
Type Description
System.String

GetFunctionInformation(String, String, Boolean, Boolean)

Declaration
public RuleManager.FunctionInformation GetFunctionInformation(string functionName, string instanceOrClassName, bool isInstance, bool briefOnly)
Parameters
Type Name Description
System.String functionName
System.String instanceOrClassName
System.Boolean isInstance
System.Boolean briefOnly
Returns
Type Description
RuleManager.FunctionInformation

GetFunctions(RuleManager.Filter, Boolean)

Declaration
public string[] GetFunctions(RuleManager.Filter filter, bool doSort)
Parameters
Type Name Description
RuleManager.Filter filter
System.Boolean doSort
Returns
Type Description
System.String[]

GetLastError()

Declaration
public string[] GetLastError()
Returns
Type Description
System.String[]

GetNameChain(NXObject)

Declaration
public string GetNameChain(NXObject ugObject)
Parameters
Type Name Description
NXObject ugObject
Returns
Type Description
System.String

GetObjectOfInstance(String)

Declaration
public NXObject GetObjectOfInstance(string nameChain)
Parameters
Type Name Description
System.String nameChain
Returns
Type Description
NXObject

GetObjectText(NXObject)

Declaration
public string GetObjectText(NXObject ugObject)
Parameters
Type Name Description
NXObject ugObject
Returns
Type Description
System.String

GetParameterFormula(String, String)

Declaration
public string GetParameterFormula(string referenceChain, string parameterName)
Parameters
Type Name Description
System.String referenceChain
System.String parameterName
Returns
Type Description
System.String

GetParameterType(String)

Declaration
public RuleManager.RuleType GetParameterType(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
RuleManager.RuleType

GetReferenceText(NXObject)

Declaration
public string GetReferenceText(NXObject ugObject)
Parameters
Type Name Description
NXObject ugObject
Returns
Type Description
System.String

GetRulesForObjects(NXObject[])

Declaration
public string GetRulesForObjects(NXObject[] ugObjects)
Parameters
Type Name Description
NXObject[] ugObjects
Returns
Type Description
System.String

GetRulesOfClass(String)

Declaration
public string[] GetRulesOfClass(string className)
Parameters
Type Name Description
System.String className
Returns
Type Description
System.String[]

GetRuleType(String)

Declaration
public RuleManager.RuleType GetRuleType(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
RuleManager.RuleType

GetRuleType(String, String)

Declaration
public RuleManager.RuleType GetRuleType(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
RuleManager.RuleType

GetRuleTypes()

Declaration
public string[] GetRuleTypes()
Returns
Type Description
System.String[]

GetSpecifiedParameters(String)

Declaration
public string[] GetSpecifiedParameters(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.String[]

Initialize(RuleManager.LicenseType, out Int32)

Declaration
public RuleManager.InitializationStatusType Initialize(RuleManager.LicenseType licenseToTake, out int intentStatus)
Parameters
Type Name Description
RuleManager.LicenseType licenseToTake
System.Int32 intentStatus
Returns
Type Description
RuleManager.InitializationStatusType

IsCanonical(String, String)

Declaration
public bool IsCanonical(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsChildList(String)

Declaration
public bool IsChildList(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsChildList(String, String)

Declaration
public bool IsChildList(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsChildRule(String)

Declaration
public bool IsChildRule(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsChildRule(String, String)

Declaration
public bool IsChildRule(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsComputed(String)

Declaration
public bool IsComputed(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsExpressionRule(String)

Declaration
public bool IsExpressionRule(string ruleName)
Parameters
Type Name Description
System.String ruleName
Returns
Type Description
System.Boolean

IsHidden(String)

Declaration
public bool IsHidden(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsHidden(String, String)

Declaration
public bool IsHidden(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsLocal(String, String)

Declaration
public bool IsLocal(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsMethod(String)

Declaration
public bool IsMethod(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsMethod(String, String)

Declaration
public bool IsMethod(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsModifiable(String)

Declaration
public bool IsModifiable(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsModifiable(String, String)

Declaration
public bool IsModifiable(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsParameter(String, String)

Declaration
public bool IsParameter(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsRuleInClass(String, String)

Declaration
public bool IsRuleInClass(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsUncached(String)

Declaration
public bool IsUncached(string referenceChain)
Parameters
Type Name Description
System.String referenceChain
Returns
Type Description
System.Boolean

IsUncached(String, String)

Declaration
public bool IsUncached(string className, string ruleName)
Parameters
Type Name Description
System.String className
System.String ruleName
Returns
Type Description
System.Boolean

IsUserClass(String)

Declaration
public bool IsUserClass(string className)
Parameters
Type Name Description
System.String className
Returns
Type Description
System.Boolean

IsUserFunction(String)

Declaration
public bool IsUserFunction(string functionName)
Parameters
Type Name Description
System.String functionName
Returns
Type Description
System.Boolean

ReadDfaFile(String)

Declaration
public string ReadDfaFile(string fileName)
Parameters
Type Name Description
System.String fileName
Returns
Type Description
System.String

RebuildTrees()

Declaration
public void RebuildTrees()

RegenerateAll()

Declaration
public void RegenerateAll()

Reload(Boolean)

Declaration
public void Reload(bool refreshUserClassDir)
Parameters
Type Name Description
System.Boolean refreshUserClassDir

ReloadClassesAndFunctions(String[], String[])

Declaration
public void ReloadClassesAndFunctions(string[] classes, string[] functions)
Parameters
Type Name Description
System.String[] classes
System.String[] functions

ReloadSingleClass(String)

Declaration
public void ReloadSingleClass(string className)
Parameters
Type Name Description
System.String className

RemoveAllRules()

Declaration
public void RemoveAllRules()

RemoveRuleOnly(String)

Declaration
public void RemoveRuleOnly(string referenceChain)
Parameters
Type Name Description
System.String referenceChain

Rename(String, String)

Declaration
public void Rename(string referenceChain, string newName)
Parameters
Type Name Description
System.String referenceChain
System.String newName

SyntaxCheck(String)

Declaration
public void SyntaxCheck(string fileName)
Parameters
Type Name Description
System.String fileName

WriteDfaFile(String, String, Boolean)

Declaration
public void WriteDfaFile(string fileName, string fileString, bool replace)
Parameters
Type Name Description
System.String fileName
System.String fileString
System.Boolean replace

Implements

System.Runtime.Remoting.Messaging.IMessageSink