Modifier and Type | Interface and Description |
---|---|
static class |
RuleManager.AdoptableTypes
Used to return adoptable object types.
|
static class |
RuleManager.DebugInstance
Used to return debug update information for instances.
|
static class |
RuleManager.DebugInstancesData
This class holds the data returned from
getDebugInstances() |
static class |
RuleManager.DebugRule
Used to return debug update information for rules.
|
static class |
RuleManager.Filter
The filter option for asking for classes.
|
static class |
RuleManager.FunctionArgumentsInformation
Used to return information about the arguments for a function.
|
static class |
RuleManager.FunctionInformation
Used to return information about a function.
|
static class |
RuleManager.InitializationStatusType
Indicates the status from initializing RuleManager.
|
static class |
RuleManager.InitializeData
This class holds the data returned from
initialize(nxopen.RuleManager.LicenseType) |
static class |
RuleManager.LicenseType
Indicates the license type to be used.
|
static class |
RuleManager.ParameterRule
Used to specify parameter values for child rule creation or modification.
|
static class |
RuleManager.RuleType
Indicates the data type of a rule.
|
Modifier and Type | Method and Description |
---|---|
boolean |
adoptObjects(NXObject[] ugObjects)
Adopt the specified ug objects.
|
void |
copy(String oldNameChain,
String oldLeafName,
String newNameChain,
String newLeafName)
Copy a dynamic child or attribute rule.
|
void |
createChildRule(String ruleName,
String className,
RuleManager.ParameterRule[] parameters)
Create a child rule and the root for this rule manager's part.
|
void |
createDynamicRule(String referenceChain,
String ruleName,
RuleManager.RuleType ruleType,
String ruleText)
Create or modify a dynamic rule.
|
void |
createDynamicRule(String referenceChain,
String ruleName,
String behaviors,
String ruleText,
String leadingComment)
Create or modify a dynamic rule.
|
void |
createDynamicRule(String referenceChain,
String ruleName,
String behaviors,
String ruleUnits,
String ruleText,
String leadingComment)
Create or modify a dynamic rule.
|
boolean |
createMode()
Returns the create mode flag.
|
boolean |
debugFlag()
Returns the debug update flag.
|
void |
deleteChildRule(String ruleName)
Delete a child rule from this rule manager.
|
void |
deleteDynamicRule(String referenceChain,
String ruleName)
Delete an existing dynamic rule.
|
int |
doKfUpdate(int undoMark)
Performs an KF update.
|
Object |
evaluate(String referenceChain)
Evaluate a rule and return its value.
|
String |
evaluateAnyAsString(String referenceChain)
Evaluate a rule and return its value as a string.
|
String |
evaluateAsString(String referenceChain)
Evaluate a rule and return its value as a string.
|
RuleManager.AdoptableTypes[] |
getAdoptableTypes()
The list of object types which can be adopted.
|
String[] |
getAncestorClasses(String className)
Get the ancestor classes for a given class.
|
String |
getClass(String referenceChain)
Get the class of a dynamic rule.
|
String |
getClassDfaFile(String className)
Get the name of the dfa file that contains the specified class.
|
String[] |
getClasses(RuleManager.Filter filter)
Get class names that match the specified filter.
|
String[] |
getClassesOfChildList(String referenceChain)
Get the classes for the members of a child list rule.
|
RuleManager.DebugInstancesData |
getDebugInstances()
Get the debug update instances.
|
String |
getDefaultFormula(String className,
String ruleName)
Returns the default formula for a rule within a class .
|
String[] |
getDependencies(String referenceChain)
Get the rules that the specified dynamic rule depends on.
|
String[] |
getDependents(String referenceChain)
Get the rules that depend on the specified dynamic rule.
|
String[] |
getDynamicRules(String childRuleName)
Get the names of all dynamic rules defined on a child rule (or Root:).
|
String |
getDynamicRuleText(String referenceChain)
Returns the rule text for a dynamic rule .
|
int |
getErrorEnd()
Get the parse error end location.
|
int |
getErrorStart()
Get the parse error start location.
|
RuleManager.FunctionArgumentsInformation[] |
getFunctionArgumentsInformation(String functionName,
String instanceOrClassName,
boolean isInstance,
boolean briefOnly)
Get information about the arguments for a function.
|
String |
getFunctionFile(String functionName)
Get the file that contains the definitions for a function.
|
RuleManager.FunctionInformation |
getFunctionInformation(String functionName,
String instanceOrClassName,
boolean isInstance,
boolean briefOnly)
Get information about a function.
|
String[] |
getFunctions(RuleManager.Filter filter,
boolean doSort)
Get functions that match the specified filter.
|
String[] |
getLastError()
Get messages for the most recent error.
|
String |
getNameChain(NXObject ugObject)
Returns the name chain
License requirements: gateway ("UG GATEWAY") . |
NXObject |
getObjectOfInstance(String nameChain)
Get object of instance
License requirements: gateway ("UG GATEWAY") . |
String |
getObjectText(NXObject ugObject)
Get the text to use when referencing the specified ug object in a rule.
|
String |
getParameterFormula(String referenceChain,
String parameterName)
Get the formula for a parameter that has been specified on a dynamic child rule.
|
RuleManager.RuleType |
getParameterType(String referenceChain)
Get the type of a parameter in a dynamic child rule.
|
String |
getReferenceText(NXObject ugObject)
Get the text to use when referencing the specified ug object in a rule.
|
String |
getRulesForObjects(NXObject[] ugObjects)
Adoption text for the specified ug objects.
|
String[] |
getRulesOfClass(String className)
Get the names of all the rules defined in a class.
|
RuleManager.RuleType |
getRuleType(String referenceChain)
Get the data type of a dynamic rule.
|
RuleManager.RuleType |
getRuleType(String className,
String ruleName)
Get the type of a rule within a class.
|
String[] |
getRuleTypes()
Get strings that describe the rule types.
|
String[] |
getSpecifiedParameters(String referenceChain)
Get the parameters that have been specified on a dynamic child rule.
|
RuleManager.InitializeData |
initialize(RuleManager.LicenseType licenseToTake)
Initialize the RuleManager.
|
boolean |
isCanonical(String className,
String ruleName)
Returns whether a rule within a class is canonical.
|
boolean |
isChildList(String referenceChain)
Returns whether a dynamic rule is a child list.
|
boolean |
isChildList(String className,
String ruleName)
Returns whether a rule within a class is a child list rule.
|
boolean |
isChildRule(String referenceChain)
Returns whether a dynamic rule is a child rule.
|
boolean |
isChildRule(String className,
String ruleName)
Returns whether a rule in a class is a child rule.
|
boolean |
isComputed(String referenceChain)
Returns whether a dynamic rule's value has been computed yet.
|
boolean |
isExpressionRule(String ruleName)
Determine whether a root level dynamic rule is mapped to an NX expression.
|
boolean |
isHidden(String referenceChain)
Returns whether a dynamic rule is hidden.
|
boolean |
isHidden(String className,
String ruleName)
Returns whether a rule within a class is hidden.
|
boolean |
isLocal(String className,
String ruleName)
Returns whether a rule within a class is local to that class.
|
boolean |
isMethod(String referenceChain)
Returns whether a dynamic rule is a method.
|
boolean |
isMethod(String className,
String ruleName)
Returns whether a rule within a class is a method.
|
boolean |
isModifiable(String referenceChain)
Returns whether a dynamic rule is modifiable.
|
boolean |
isModifiable(String className,
String ruleName)
Returns whether a rule within a class is modifiable.
|
boolean |
isParameter(String className,
String ruleName)
Returns whether a rule within a class is a parameter of that class.
|
boolean |
isRuleInClass(String className,
String ruleName)
Returns whether the rule is defined in the specified class.
|
boolean |
isUncached(String referenceChain)
Returns whether a dynamic rule is uncached.
|
boolean |
isUncached(String className,
String ruleName)
Returns whether a rule within a class is uncached.
|
boolean |
isUserClass(String className)
Determine whether a class is a user class.
|
boolean |
isUserFunction(String functionName)
Determine whether a function is one defined by the user.
|
String |
readDfaFile(String fileName)
Read a dfa file and return its contents as a string.
|
void |
rebuildTrees()
Rebuilds the KF Navigator tree and any Part Inspector trees that are being shown.
|
void |
regenerateAll()
Regenerate all rules.
|
void |
reload(boolean refreshUserClassDir)
Reload all classes and functions.
|
void |
reloadClassesAndFunctions(String[] classes,
String[] functions)
Reload specified classes and functions.
|
void |
reloadSingleClass(String className)
Reload a single class.
|
void |
removeAllRules()
Remove all rules in the part.
|
void |
removeRuleOnly(String referenceChain)
Remove a dynamic child or attribute rule, but leave the geometry.
|
void |
rename(String referenceChain,
String newName)
Rename a dynamic child or attribute rule.
|
void |
setDebugFlag(boolean debugFlag)
License requirements: gateway ("UG GATEWAY") . |
void |
syntaxCheck(String fileName)
Run the syntax check on a dfa file.
|
void |
writeDfaFile(String fileName,
String fileString,
boolean replace)
Write a string out to a dfa file.
|
RuleManager.InitializeData initialize(RuleManager.LicenseType licenseToTake) throws NXException, RemoteException
licenseToTake
- Which license to takeNXException
RemoteException
void createDynamicRule(String referenceChain, String ruleName, RuleManager.RuleType ruleType, String ruleText) throws NXException, RemoteException
referenceChain
- Reference chain for instance in which to create the dynamic ruleruleName
- Name of rule to createruleType
- Data type for the new ruleruleText
- Value for the new rule as a stringNXException
RemoteException
void createDynamicRule(String referenceChain, String ruleName, String behaviors, String ruleUnits, String ruleText, String leadingComment) throws NXException, RemoteException
referenceChain
- Reference chain for instance in which to create the dynamic ruleruleName
- Name of rule to createbehaviors
- Behaviors for the new rule, for example, "Number Modifiable"ruleUnits
- Unit for the new rule, for example, "mm"ruleText
- Value for the new rule as a stringleadingComment
- Leading comment for rule. This can be NULLNXException
RemoteException
void createDynamicRule(String referenceChain, String ruleName, String behaviors, String ruleText, String leadingComment) throws NXException, RemoteException
referenceChain
- Reference chain for instance in which to create the dynamic ruleruleName
- Name of rule to createbehaviors
- Behaviors for the new rule, for example, "Number Modifiable"ruleText
- Value for the new rule as a stringleadingComment
- Leading comment for rule. This can be NULLNXException
RemoteException
int doKfUpdate(int undoMark) throws NXException, RemoteException
Update.doUpdate(int)
except that it does some addition updating to make sure CAE objects are complete.
undoMark
- If any update error occurs, the system
will roll back to this
undo mark.Update.errorList()
NXException
RemoteException
void deleteDynamicRule(String referenceChain, String ruleName) throws NXException, RemoteException
referenceChain
- Reference chain for instance from which to delete the dynamic ruleruleName
- Name of rule to deleteNXException
RemoteException
void createChildRule(String ruleName, String className, RuleManager.ParameterRule[] parameters) throws NXException, RemoteException
ruleName
- Name of child rule to createclassName
- Class to instantiate as this childparameters
- Input parameters for this classNXException
RemoteException
void deleteChildRule(String ruleName) throws NXException, RemoteException
ruleName
- Name of child to deleteNXException
RemoteException
void removeRuleOnly(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for rule to removeNXException
RemoteException
boolean isUserClass(String className) throws NXException, RemoteException
className
- Class nameNXException
RemoteException
String[] getRulesOfClass(String className) throws NXException, RemoteException
className
- Class nameNXException
RemoteException
String[] getDynamicRules(String childRuleName) throws NXException, RemoteException
childRuleName
- reference chain of child ruleNXException
RemoteException
String[] getSpecifiedParameters(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
String getParameterFormula(String referenceChain, String parameterName) throws NXException, RemoteException
referenceChain
- Reference chain for ruleparameterName
- Parameter nameNXException
RemoteException
void rename(String referenceChain, String newName) throws NXException, RemoteException
referenceChain
- Reference chain for rule to renamenewName
- New leaf nameNXException
RemoteException
void copy(String oldNameChain, String oldLeafName, String newNameChain, String newLeafName) throws NXException, RemoteException
oldNameChain
- Name chain for rule to copyoldLeafName
- Leaf name of rule to copynewNameChain
- Name chain for copied rulenewLeafName
- Leaf name for copied ruleNXException
RemoteException
String getClass(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
String[] getClassesOfChildList(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
String[] getDependents(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
String[] getDependencies(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
RuleManager.RuleType getRuleType(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
RuleManager.RuleType getRuleType(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
RuleManager.RuleType getParameterType(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isChildRule(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isChildRule(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isChildList(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isChildList(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isUncached(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isUncached(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isHidden(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isHidden(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isLocal(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isParameter(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isCanonical(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isModifiable(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isModifiable(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isMethod(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
boolean isMethod(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
boolean isComputed(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for ruleNXException
RemoteException
void rebuildTrees() throws NXException, RemoteException
NXException
RemoteException
boolean isRuleInClass(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
String getDefaultFormula(String className, String ruleName) throws NXException, RemoteException
className
- Class nameruleName
- Rule name within the classNXException
RemoteException
Object evaluate(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for the rule to evaluateNXException
RemoteException
String evaluateAsString(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for the rule to evaluateNXException
RemoteException
String evaluateAnyAsString(String referenceChain) throws NXException, RemoteException
referenceChain
- Reference chain for the rule to evaluateNXException
RemoteException
String getNameChain(NXObject ugObject) throws NXException, RemoteException
ugObject
- object to find name chainNXException
RemoteException
void regenerateAll() throws NXException, RemoteException
NXException
RemoteException
void syntaxCheck(String fileName) throws NXException, RemoteException
fileName
- dfa file to check NXException
RemoteException
String[] getAncestorClasses(String className) throws NXException, RemoteException
className
- class name for which to get component classesNXException
RemoteException
void reload(boolean refreshUserClassDir) throws NXException, RemoteException
refreshUserClassDir
- flag for whether to refresh search dirs after loadNXException
RemoteException
void reloadSingleClass(String className) throws NXException, RemoteException
className
- class name to reloadNXException
RemoteException
void reloadClassesAndFunctions(String[] classes, String[] functions) throws NXException, RemoteException
classes
- names of classes to reloadfunctions
- names of functions to reloadNXException
RemoteException
String[] getRuleTypes() throws NXException, RemoteException
NXException
RemoteException
String[] getClasses(RuleManager.Filter filter) throws NXException, RemoteException
filter
- filter for classesNXException
RemoteException
String[] getFunctions(RuleManager.Filter filter, boolean doSort) throws NXException, RemoteException
filter
- filter for functionsdoSort
- TRUE to get the functions sorted alphabeticallyNXException
RemoteException
void removeAllRules() throws NXException, RemoteException
NXException
RemoteException
String readDfaFile(String fileName) throws NXException, RemoteException
fileName
- File name to readNXException
RemoteException
void writeDfaFile(String fileName, String fileString, boolean replace) throws NXException, RemoteException
fileName
- File name to writefileString
- String to write to filereplace
- if TRUE, replace the file if it existsNXException
RemoteException
String getClassDfaFile(String className) throws NXException, RemoteException
className
- Class nameNXException
RemoteException
String[] getLastError() throws NXException, RemoteException
NXException
RemoteException
String getReferenceText(NXObject ugObject) throws NXException, RemoteException
getObjectText(nxopen.NXObject)
.
ugObject
- object to find reference text forNXException
RemoteException
String getObjectText(NXObject ugObject) throws NXException, RemoteException
ugObject
- object to find object text forNXException
RemoteException
boolean adoptObjects(NXObject[] ugObjects) throws NXException, RemoteException
ugObjects
- objects to adoptNXException
RemoteException
RuleManager.AdoptableTypes[] getAdoptableTypes() throws NXException, RemoteException
NXException
RemoteException
String getRulesForObjects(NXObject[] ugObjects) throws NXException, RemoteException
ugObjects
- objects to adoptNXException
RemoteException
RuleManager.FunctionInformation getFunctionInformation(String functionName, String instanceOrClassName, boolean isInstance, boolean briefOnly) throws NXException, RemoteException
functionName
- Function nameinstanceOrClassName
- Instance or class name (used only for a method otherwise null or NothingisInstance
- TRUE if instance name passed, FALSE otherwisebriefOnly
- TRUE if returning brief information onlyNXException
RemoteException
RuleManager.FunctionArgumentsInformation[] getFunctionArgumentsInformation(String functionName, String instanceOrClassName, boolean isInstance, boolean briefOnly) throws NXException, RemoteException
functionName
- Function nameinstanceOrClassName
- Instance or class name (used only for a method)isInstance
- TRUE if instance name passed, FALSE otherwisebriefOnly
- TRUE if returning brief information onlyNXException
RemoteException
String getFunctionFile(String functionName) throws NXException, RemoteException
functionName
- Function nameNXException
RemoteException
boolean isUserFunction(String functionName) throws NXException, RemoteException
functionName
- Function nameNXException
RemoteException
boolean isExpressionRule(String ruleName) throws NXException, RemoteException
ruleName
- Dynamic rule nameNXException
RemoteException
String getDynamicRuleText(String referenceChain) throws NXException, RemoteException
referenceChain
- name chain for a dynamic ruleNXException
RemoteException
boolean debugFlag() throws NXException, RemoteException
NXException
RemoteException
void setDebugFlag(boolean debugFlag) throws NXException, RemoteException
debugFlag
- NXException
RemoteException
RuleManager.DebugInstancesData getDebugInstances() throws NXException, RemoteException
NXException
RemoteException
boolean createMode() throws NXException, RemoteException
NXException
RemoteException
int getErrorStart() throws NXException, RemoteException
NXException
RemoteException
int getErrorEnd() throws NXException, RemoteException
NXException
RemoteException
NXObject getObjectOfInstance(String nameChain) throws NXException, RemoteException
nameChain
- Name chain of instanceNXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.