|
NX Open C++ Reference Guide
|
Provides methods for manipulating the Knowledge Fusion rules in a part. More...
Classes | |
| 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 | Filter { FilterUser, FilterSystem, FilterBoth, FilterUserPlus, FilterUserLoaded, FilterSystemLoaded, FilterBothLoaded, FilterUserPlusLoaded } |
| The filter option for asking for classes. More... | |
| enum | InitializationStatusType { InitializationStatusTypeSuccess, InitializationStatusTypeFailure, InitializationStatusTypeUnavailable, InitializationStatusTypeUnableToObtainLicense, InitializationStatusTypeCloseFailure } |
| Indicates the status from initializing RuleManager. More... | |
| enum | LicenseType { LicenseTypeNoLicense, LicenseTypeAuthor, LicenseTypeExecute, LicenseTypePipeline, LicenseTypeKfFeature, LicenseTypeKfInterop, LicenseTypeKfNewGeom, LicenseTypeKfChecking } |
| Indicates the license type to be used. More... | |
| enum | RuleType { RuleTypeBoolean, RuleTypeFrame, RuleTypeInteger, RuleTypeList, RuleTypeName, RuleTypeNumber, RuleTypePoint, RuleTypeString, RuleTypeVector, RuleTypeInstance, RuleTypeAny, RuleTypeHostPointer } |
| Indicates the data type of a rule. More... | |
Public Member Functions | |
| bool | AdoptObjects (const std::vector< NXOpen::NXObject * > &ugObjects) |
| Adopt the specified ug objects. | |
| void | Copy (const NXString &oldNameChain, const NXString &oldLeafName, const NXString &newNameChain, const NXString &newLeafName) |
| Copy a dynamic child or attribute rule. | |
| void | Copy (const char *oldNameChain, const char *oldLeafName, const char *newNameChain, const char *newLeafName) |
| Copy a dynamic child or attribute rule. | |
| void | CreateChildRule (const NXString &ruleName, const NXString &className, const std::vector< NXOpen::RuleManager::ParameterRule > ¶meters) |
| Create a child rule and the root for this rule manager's part. | |
| void | CreateChildRule (const char *ruleName, const char *className, const std::vector< NXOpen::RuleManager::ParameterRule > ¶meters) |
| Create a child rule and the root for this rule manager's part. | |
| void | CreateDynamicRule (const NXString &referenceChain, const NXString &ruleName, NXOpen::RuleManager::RuleType ruleType, const NXString &ruleText) |
| Create or modify a dynamic rule. | |
| void | CreateDynamicRule (const char *referenceChain, const char *ruleName, NXOpen::RuleManager::RuleType ruleType, const char *ruleText) |
| Create or modify a dynamic rule. | |
| void | CreateDynamicRule (const NXString &referenceChain, const NXString &ruleName, const NXString &behaviors, const NXString &ruleUnits, const NXString &ruleText, const NXString &leadingComment) |
| Create or modify a dynamic rule. | |
| void | CreateDynamicRule (const char *referenceChain, const char *ruleName, const char *behaviors, const char *ruleUnits, const char *ruleText, const char *leadingComment) |
| Create or modify a dynamic rule. | |
| void | CreateDynamicRule (const NXString &referenceChain, const NXString &ruleName, const NXString &behaviors, const NXString &ruleText, const NXString &leadingComment) |
| Create or modify a dynamic rule. | |
| void | CreateDynamicRule (const char *referenceChain, const char *ruleName, const char *behaviors, const char *ruleText, const char *leadingComment) |
| Create or modify a dynamic rule. | |
| bool | CreateMode () |
| Returns the create mode flag. | |
| bool | DebugFlag () |
| Returns the debug update flag. | |
| void | DeleteChildRule (const NXString &ruleName) |
| Delete a child rule from this rule manager. | |
| void | DeleteChildRule (const char *ruleName) |
| Delete a child rule from this rule manager. | |
| void | DeleteDynamicRule (const NXString &referenceChain, const NXString &ruleName) |
| Delete an existing dynamic rule. | |
| void | DeleteDynamicRule (const char *referenceChain, const char *ruleName) |
| Delete an existing dynamic rule. | |
| int | DoKfUpdate (NXOpen::Session::UndoMarkId undoMark) |
| Performs an KF update. | |
| NXString | EvaluateAnyAsString (const NXString &referenceChain) |
| Evaluate a rule and return its value as a string. | |
| NXString | EvaluateAnyAsString (const char *referenceChain) |
| Evaluate a rule and return its value as a string. | |
| NXString | EvaluateAsString (const NXString &referenceChain) |
| Evaluate a rule and return its value as a string. | |
| NXString | EvaluateAsString (const char *referenceChain) |
| Evaluate a rule and return its value as a string. | |
| std::vector < NXOpen::RuleManager::AdoptableTypes > | GetAdoptableTypes () |
| The list of object types which can be adopted. | |
| std::vector< NXString > | GetAncestorClasses (const NXString &className) |
| Get the ancestor classes for a given class. | |
| std::vector< NXString > | GetAncestorClasses (const char *className) |
| Get the ancestor classes for a given class. | |
| NXString | GetClass (const NXString &referenceChain) |
| Get the class of a dynamic rule. | |
| NXString | GetClass (const char *referenceChain) |
| Get the class of a dynamic rule. | |
| NXString | GetClassDfaFile (const NXString &className) |
| Get the name of the dfa file that contains the specified class. | |
| NXString | GetClassDfaFile (const char *className) |
| Get the name of the dfa file that contains the specified class. | |
| std::vector< NXString > | GetClasses (NXOpen::RuleManager::Filter filter) |
| Get class names that match the specified filter. | |
| std::vector< NXString > | GetClassesOfChildList (const NXString &referenceChain) |
| Get the classes for the members of a child list rule. | |
| std::vector< NXString > | GetClassesOfChildList (const char *referenceChain) |
| Get the classes for the members of a child list rule. | |
| void | GetDebugInstances (std::vector< NXOpen::RuleManager::DebugInstance > &instances, std::vector< NXOpen::RuleManager::DebugRule > &rules) |
| Get the debug update instances. | |
| NXString | GetDefaultFormula (const NXString &className, const NXString &ruleName) |
| Returns the default formula for a rule within a class . | |
| NXString | GetDefaultFormula (const char *className, const char *ruleName) |
| Returns the default formula for a rule within a class . | |
| std::vector< NXString > | GetDependencies (const NXString &referenceChain) |
| Get the rules that the specified dynamic rule depends on. | |
| std::vector< NXString > | GetDependencies (const char *referenceChain) |
| Get the rules that the specified dynamic rule depends on. | |
| std::vector< NXString > | GetDependents (const NXString &referenceChain) |
| Get the rules that depend on the specified dynamic rule. | |
| std::vector< NXString > | GetDependents (const char *referenceChain) |
| Get the rules that depend on the specified dynamic rule. | |
| std::vector< NXString > | GetDynamicRules (const NXString &childRuleName) |
| Get the reference chains of all dynamic rules defined on a child rule (or Root:). | |
| std::vector< NXString > | GetDynamicRules (const char *childRuleName) |
| Get the reference chains of all dynamic rules defined on a child rule (or Root:). | |
| NXString | GetDynamicRuleText (const NXString &referenceChain) |
| Returns the rule text for a dynamic rule . | |
| NXString | GetDynamicRuleText (const char *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. | |
| std::vector < NXOpen::RuleManager::FunctionArgumentsInformation > | GetFunctionArgumentsInformation (const NXString &functionName, const NXString &instanceOrClassName, bool isInstance, bool briefOnly) |
| Get information about the arguments for a function. | |
| std::vector < NXOpen::RuleManager::FunctionArgumentsInformation > | GetFunctionArgumentsInformation (const char *functionName, const char *instanceOrClassName, bool isInstance, bool briefOnly) |
| Get information about the arguments for a function. | |
| NXString | GetFunctionFile (const NXString &functionName) |
| Get the file that contains the definitions for a function. | |
| NXString | GetFunctionFile (const char *functionName) |
| Get the file that contains the definitions for a function. | |
| NXOpen::RuleManager::FunctionInformation | GetFunctionInformation (const NXString &functionName, const NXString &instanceOrClassName, bool isInstance, bool briefOnly) |
| Get information about a function. | |
| NXOpen::RuleManager::FunctionInformation | GetFunctionInformation (const char *functionName, const char *instanceOrClassName, bool isInstance, bool briefOnly) |
| Get information about a function. | |
| std::vector< NXString > | GetFunctions (NXOpen::RuleManager::Filter filter, bool doSort) |
| Get functions that match the specified filter. | |
| std::vector< NXString > | GetLastError () |
| Get messages for the most recent error. | |
| NXString | GetNameChain (NXOpen::NXObject *ugObject) |
| Returns the name chain. | |
| NXString | GetObjectText (NXOpen::NXObject *ugObject) |
| Get the text to use when referencing the specified ug object in a rule. | |
| NXString | GetParameterFormula (const NXString &referenceChain, const NXString ¶meterName) |
| Get the formula for a parameter that has been specified on a dynamic child rule. | |
| NXString | GetParameterFormula (const char *referenceChain, const char *parameterName) |
| Get the formula for a parameter that has been specified on a dynamic child rule. | |
| NXOpen::RuleManager::RuleType | GetParameterType (const NXString &referenceChain) |
| Get the type of a parameter in a dynamic child rule. | |
| NXOpen::RuleManager::RuleType | GetParameterType (const char *referenceChain) |
| Get the type of a parameter in a dynamic child rule. | |
| NXString | GetReferenceText (NXOpen::NXObject *ugObject) |
| Get the text to use when referencing the specified ug object in a rule. | |
| NXString | GetRulesForObjects (const std::vector< NXOpen::NXObject * > &ugObjects) |
| Adoption text for the specified ug objects. | |
| std::vector< NXString > | GetRulesOfClass (const NXString &className) |
| Get the names of all the rules defined in a class. | |
| std::vector< NXString > | GetRulesOfClass (const char *className) |
| Get the names of all the rules defined in a class. | |
| NXOpen::RuleManager::RuleType | GetRuleType (const NXString &className, const NXString &ruleName) |
| Get the type of a rule within a class. | |
| NXOpen::RuleManager::RuleType | GetRuleType (const char *className, const char *ruleName) |
| Get the type of a rule within a class. | |
| NXOpen::RuleManager::RuleType | GetRuleType (const NXString &referenceChain) |
| Get the data type of a dynamic rule. | |
| NXOpen::RuleManager::RuleType | GetRuleType (const char *referenceChain) |
| Get the data type of a dynamic rule. | |
| std::vector< NXString > | GetRuleTypes () |
| Get strings that describe the rule types. | |
| std::vector< NXString > | GetSpecifiedParameters (const NXString &referenceChain) |
| Get the parameters that have been specified on a dynamic child rule. | |
| std::vector< NXString > | GetSpecifiedParameters (const char *referenceChain) |
| Get the parameters that have been specified on a dynamic child rule. | |
| NXOpen::RuleManager::InitializationStatusType | Initialize (NXOpen::RuleManager::LicenseType licenseToTake, int *intentStatus) |
| Initialize the RuleManager. | |
| bool | IsCanonical (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is canonical. | |
| bool | IsCanonical (const char *className, const char *ruleName) |
| Returns whether a rule within a class is canonical. | |
| bool | IsChildList (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is a child list rule. | |
| bool | IsChildList (const char *className, const char *ruleName) |
| Returns whether a rule within a class is a child list rule. | |
| bool | IsChildList (const NXString &referenceChain) |
| Returns whether a dynamic rule is a child list. | |
| bool | IsChildList (const char *referenceChain) |
| Returns whether a dynamic rule is a child list. | |
| bool | IsChildRule (const NXString &className, const NXString &ruleName) |
| Returns whether a rule in a class is a child rule. | |
| bool | IsChildRule (const char *className, const char *ruleName) |
| Returns whether a rule in a class is a child rule. | |
| bool | IsChildRule (const NXString &referenceChain) |
| Returns whether a dynamic rule is a child rule. | |
| bool | IsChildRule (const char *referenceChain) |
| Returns whether a dynamic rule is a child rule. | |
| bool | IsComputed (const NXString &referenceChain) |
| Returns whether a dynamic rule's value has been computed yet. | |
| bool | IsComputed (const char *referenceChain) |
| Returns whether a dynamic rule's value has been computed yet. | |
| bool | IsExpressionRule (const NXString &ruleName) |
| Determine whether a root level dynamic rule is mapped to an NX expression. | |
| bool | IsExpressionRule (const char *ruleName) |
| Determine whether a root level dynamic rule is mapped to an NX expression. | |
| bool | IsHidden (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is hidden. | |
| bool | IsHidden (const char *className, const char *ruleName) |
| Returns whether a rule within a class is hidden. | |
| bool | IsHidden (const NXString &referenceChain) |
| Returns whether a dynamic rule is hidden. | |
| bool | IsHidden (const char *referenceChain) |
| Returns whether a dynamic rule is hidden. | |
| bool | IsLocal (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is local to that class. | |
| bool | IsLocal (const char *className, const char *ruleName) |
| Returns whether a rule within a class is local to that class. | |
| bool | IsMethod (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is a method. | |
| bool | IsMethod (const char *className, const char *ruleName) |
| Returns whether a rule within a class is a method. | |
| bool | IsMethod (const NXString &referenceChain) |
| Returns whether a dynamic rule is a method. | |
| bool | IsMethod (const char *referenceChain) |
| Returns whether a dynamic rule is a method. | |
| bool | IsModifiable (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is modifiable. | |
| bool | IsModifiable (const char *className, const char *ruleName) |
| Returns whether a rule within a class is modifiable. | |
| bool | IsModifiable (const NXString &referenceChain) |
| Returns whether a dynamic rule is modifiable. | |
| bool | IsModifiable (const char *referenceChain) |
| Returns whether a dynamic rule is modifiable. | |
| bool | IsParameter (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is a parameter of that class. | |
| bool | IsParameter (const char *className, const char *ruleName) |
| Returns whether a rule within a class is a parameter of that class. | |
| bool | IsRuleInClass (const NXString &className, const NXString &ruleName) |
| Returns whether the rule is defined in the specified class. | |
| bool | IsRuleInClass (const char *className, const char *ruleName) |
| Returns whether the rule is defined in the specified class. | |
| bool | IsUncached (const NXString &className, const NXString &ruleName) |
| Returns whether a rule within a class is uncached. | |
| bool | IsUncached (const char *className, const char *ruleName) |
| Returns whether a rule within a class is uncached. | |
| bool | IsUncached (const NXString &referenceChain) |
| Returns whether a dynamic rule is uncached. | |
| bool | IsUncached (const char *referenceChain) |
| Returns whether a dynamic rule is uncached. | |
| bool | IsUserClass (const NXString &className) |
| Determine whether a class is a user class. | |
| bool | IsUserClass (const char *className) |
| Determine whether a class is a user class. | |
| bool | IsUserFunction (const NXString &functionName) |
| Determine whether a function is one defined by the user. | |
| bool | IsUserFunction (const char *functionName) |
| Determine whether a function is one defined by the user. | |
| NXString | ReadDfaFile (const NXString &fileName) |
| Read a dfa file and return its contents as a string. | |
| NXString | ReadDfaFile (const char *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 (bool refreshUserClassDir) |
| Reload all classes and functions. | |
| void | ReloadClassesAndFunctions (std::vector< NXString > &classes, std::vector< NXString > &functions) |
| Reload specified classes and functions. | |
| void | ReloadSingleClass (const NXString &className) |
| Reload a single class. | |
| void | ReloadSingleClass (const char *className) |
| Reload a single class. | |
| void | RemoveAllRules () |
| Remove all rules in the part. | |
| void | RemoveRuleOnly (const NXString &referenceChain) |
| Remove a dynamic child or attribute rule, but leave the geometry. | |
| void | RemoveRuleOnly (const char *referenceChain) |
| Remove a dynamic child or attribute rule, but leave the geometry. | |
| void | Rename (const NXString &referenceChain, const NXString &newName) |
| Rename a dynamic child or attribute rule. | |
| void | Rename (const char *referenceChain, const char *newName) |
| Rename a dynamic child or attribute rule. | |
| void | SetDebugFlag (bool debugFlag) |
| Sets the debug update flag. | |
| void | SyntaxCheck (const NXString &fileName) |
| Run the syntax check on a dfa file. | |
| void | SyntaxCheck (const char *fileName) |
| Run the syntax check on a dfa file. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
| void | WriteDfaFile (const NXString &fileName, const NXString &fileString, bool replace) |
| Write a string out to a dfa file. | |
| void | WriteDfaFile (const char *fileName, const char *fileString, bool replace) |
| Write a string out to a dfa file. | |
Provides methods for manipulating the Knowledge Fusion rules in a part.
To obtain an instance of this class, refer to BasePart
Created in NX3.0.0.
The filter option for asking for classes.
Indicates the status from initializing RuleManager.
Indicates the data type of a rule.
| bool NXOpen::RuleManager::AdoptObjects | ( | const std::vector< NXOpen::NXObject * > & | ugObjects | ) |
Adopt the specified ug objects.
| ugObjects | objects to adopt |
| void NXOpen::RuleManager::Copy | ( | const NXString & | oldNameChain, |
| const NXString & | oldLeafName, | ||
| const NXString & | newNameChain, | ||
| const NXString & | newLeafName | ||
| ) |
Copy a dynamic child or attribute rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| oldNameChain | Name chain for rule to copy |
| oldLeafName | Leaf name of rule to copy |
| newNameChain | Name chain for copied rule |
| newLeafName | Leaf name for copied rule |
| void NXOpen::RuleManager::Copy | ( | const char * | oldNameChain, |
| const char * | oldLeafName, | ||
| const char * | newNameChain, | ||
| const char * | newLeafName | ||
| ) |
Copy a dynamic child or attribute rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| oldNameChain | Name chain for rule to copy |
| oldLeafName | Leaf name of rule to copy |
| newNameChain | Name chain for copied rule |
| newLeafName | Leaf name for copied rule |
| void NXOpen::RuleManager::CreateChildRule | ( | const NXString & | ruleName, |
| const NXString & | className, | ||
| const std::vector< NXOpen::RuleManager::ParameterRule > & | parameters | ||
| ) |
Create a child rule and the root for this rule manager's part.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| ruleName | Name of child rule to create |
| className | Class to instantiate as this child |
| parameters | Input parameters for this class |
| void NXOpen::RuleManager::CreateChildRule | ( | const char * | ruleName, |
| const char * | className, | ||
| const std::vector< NXOpen::RuleManager::ParameterRule > & | parameters | ||
| ) |
Create a child rule and the root for this rule manager's part.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| ruleName | Name of child rule to create |
| className | Class to instantiate as this child |
| parameters | Input parameters for this class |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const NXString & | referenceChain, |
| const NXString & | ruleName, | ||
| NXOpen::RuleManager::RuleType | ruleType, | ||
| const NXString & | ruleText | ||
| ) |
Create or modify a dynamic rule.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| ruleType | Data type for the new rule |
| ruleText | Value for the new rule as a string |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const char * | referenceChain, |
| const char * | ruleName, | ||
| NXOpen::RuleManager::RuleType | ruleType, | ||
| const char * | ruleText | ||
| ) |
Create or modify a dynamic rule.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| ruleType | Data type for the new rule |
| ruleText | Value for the new rule as a string |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const NXString & | referenceChain, |
| const NXString & | ruleName, | ||
| const NXString & | behaviors, | ||
| const NXString & | ruleUnits, | ||
| const NXString & | ruleText, | ||
| const NXString & | leadingComment | ||
| ) |
Create or modify a dynamic rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| behaviors | 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 string |
| leadingComment | Leading comment for rule. This can be NULL |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const char * | referenceChain, |
| const char * | ruleName, | ||
| const char * | behaviors, | ||
| const char * | ruleUnits, | ||
| const char * | ruleText, | ||
| const char * | leadingComment | ||
| ) |
Create or modify a dynamic rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| behaviors | 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 string |
| leadingComment | Leading comment for rule. This can be NULL |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const NXString & | referenceChain, |
| const NXString & | ruleName, | ||
| const NXString & | behaviors, | ||
| const NXString & | ruleText, | ||
| const NXString & | leadingComment | ||
| ) |
Create or modify a dynamic rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| behaviors | Behaviors for the new rule, for example, "Number Modifiable" |
| ruleText | Value for the new rule as a string |
| leadingComment | Leading comment for rule. This can be NULL |
| void NXOpen::RuleManager::CreateDynamicRule | ( | const char * | referenceChain, |
| const char * | ruleName, | ||
| const char * | behaviors, | ||
| const char * | ruleText, | ||
| const char * | leadingComment | ||
| ) |
Create or modify a dynamic rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance in which to create the dynamic rule |
| ruleName | Name of rule to create |
| behaviors | Behaviors for the new rule, for example, "Number Modifiable" |
| ruleText | Value for the new rule as a string |
| leadingComment | Leading comment for rule. This can be NULL |
| bool NXOpen::RuleManager::CreateMode | ( | ) |
Returns the create mode flag.
Created in NX5.0.0.
License requirements : None
| bool NXOpen::RuleManager::DebugFlag | ( | ) |
Returns the debug update flag.
Created in NX5.0.0.
License requirements : None
| void NXOpen::RuleManager::DeleteChildRule | ( | const NXString & | ruleName | ) |
Delete a child rule from this rule manager.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| ruleName | Name of child to delete |
| void NXOpen::RuleManager::DeleteChildRule | ( | const char * | ruleName | ) |
Delete a child rule from this rule manager.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| ruleName | Name of child to delete |
| void NXOpen::RuleManager::DeleteDynamicRule | ( | const NXString & | referenceChain, |
| const NXString & | ruleName | ||
| ) |
Delete an existing dynamic rule.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance from which to delete the dynamic rule |
| ruleName | Name of rule to delete |
| void NXOpen::RuleManager::DeleteDynamicRule | ( | const char * | referenceChain, |
| const char * | ruleName | ||
| ) |
Delete an existing dynamic rule.
Created in NX3.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for instance from which to delete the dynamic rule |
| ruleName | Name of rule to delete |
| 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.
| undoMark | If any update error occurs, the system will roll back to this undo mark. |
Evaluate a rule and return its value as a string.
| referenceChain | Reference chain for the rule to evaluate |
| NXString NXOpen::RuleManager::EvaluateAnyAsString | ( | const char * | referenceChain | ) |
Evaluate a rule and return its value as a string.
| referenceChain | Reference chain for the rule to evaluate |
Evaluate a rule and return its value as a string.
| referenceChain | Reference chain for the rule to evaluate |
| NXString NXOpen::RuleManager::EvaluateAsString | ( | const char * | referenceChain | ) |
Evaluate a rule and return its value as a string.
| referenceChain | Reference chain for the rule to evaluate |
| std::vector<NXOpen::RuleManager::AdoptableTypes> NXOpen::RuleManager::GetAdoptableTypes | ( | ) |
The list of object types which can be adopted.
Get the ancestor classes for a given class.
| className | class name for which to get component classes |
| std::vector<NXString> NXOpen::RuleManager::GetAncestorClasses | ( | const char * | className | ) |
Get the ancestor classes for a given class.
| className | class name for which to get component classes |
Get the class of a dynamic rule.
| referenceChain | Reference chain for rule |
| NXString NXOpen::RuleManager::GetClass | ( | const char * | referenceChain | ) |
Get the class of a dynamic rule.
| referenceChain | Reference chain for rule |
Get the name of the dfa file that contains the specified class.
| className | Class name |
| NXString NXOpen::RuleManager::GetClassDfaFile | ( | const char * | className | ) |
Get the name of the dfa file that contains the specified class.
| className | Class name |
| std::vector<NXString> NXOpen::RuleManager::GetClasses | ( | NXOpen::RuleManager::Filter | filter | ) |
Get class names that match the specified filter.
| filter | filter for classes |
Get the classes for the members of a child list rule.
| referenceChain | Reference chain for rule |
| std::vector<NXString> NXOpen::RuleManager::GetClassesOfChildList | ( | const char * | referenceChain | ) |
Get the classes for the members of a child list rule.
| referenceChain | Reference chain for rule |
| void NXOpen::RuleManager::GetDebugInstances | ( | std::vector< NXOpen::RuleManager::DebugInstance > & | instances, |
| std::vector< NXOpen::RuleManager::DebugRule > & | rules | ||
| ) |
Get the debug update instances.
Created in NX5.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author")
| instances | Array of instances |
| rules | Array of rules |
| NXString NXOpen::RuleManager::GetDefaultFormula | ( | const NXString & | className, |
| const NXString & | ruleName | ||
| ) |
Returns the default formula for a rule within a class .
| className | Class name |
| ruleName | Rule name within the class |
| NXString NXOpen::RuleManager::GetDefaultFormula | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns the default formula for a rule within a class .
| className | Class name |
| ruleName | Rule name within the class |
Get the rules that the specified dynamic rule depends on.
| referenceChain | Reference chain for rule |
| std::vector<NXString> NXOpen::RuleManager::GetDependencies | ( | const char * | referenceChain | ) |
Get the rules that the specified dynamic rule depends on.
| referenceChain | Reference chain for rule |
Get the rules that depend on the specified dynamic rule.
| referenceChain | Reference chain for rule |
| std::vector<NXString> NXOpen::RuleManager::GetDependents | ( | const char * | referenceChain | ) |
Get the rules that depend on the specified dynamic rule.
| referenceChain | Reference chain for rule |
Get the reference chains of all dynamic rules defined on a child rule (or Root:).
| childRuleName | Name of child rule |
| std::vector<NXString> NXOpen::RuleManager::GetDynamicRules | ( | const char * | childRuleName | ) |
Get the reference chains of all dynamic rules defined on a child rule (or Root:).
| childRuleName | Name of child rule |
Returns the rule text for a dynamic rule .
| referenceChain | name chain for a dynamic rule |
| NXString NXOpen::RuleManager::GetDynamicRuleText | ( | const char * | referenceChain | ) |
Returns the rule text for a dynamic rule .
| referenceChain | name chain for a dynamic rule |
| int NXOpen::RuleManager::GetErrorEnd | ( | ) |
Get the parse error end location.
| int NXOpen::RuleManager::GetErrorStart | ( | ) |
Get the parse error start location.
| std::vector<NXOpen::RuleManager::FunctionArgumentsInformation> NXOpen::RuleManager::GetFunctionArgumentsInformation | ( | const NXString & | functionName, |
| const NXString & | instanceOrClassName, | ||
| bool | isInstance, | ||
| bool | briefOnly | ||
| ) |
Get information about the arguments for a function.
| functionName | Function name |
| instanceOrClassName | Instance or class name (used only for a method) |
| isInstance | TRUE if instance name passed, FALSE otherwise |
| briefOnly | TRUE if returning brief information only |
| std::vector<NXOpen::RuleManager::FunctionArgumentsInformation> NXOpen::RuleManager::GetFunctionArgumentsInformation | ( | const char * | functionName, |
| const char * | instanceOrClassName, | ||
| bool | isInstance, | ||
| bool | briefOnly | ||
| ) |
Get information about the arguments for a function.
| functionName | Function name |
| instanceOrClassName | Instance or class name (used only for a method) |
| isInstance | TRUE if instance name passed, FALSE otherwise |
| briefOnly | TRUE if returning brief information only |
Get the file that contains the definitions for a function.
| functionName | Function name |
| NXString NXOpen::RuleManager::GetFunctionFile | ( | const char * | functionName | ) |
Get the file that contains the definitions for a function.
| functionName | Function name |
| NXOpen::RuleManager::FunctionInformation NXOpen::RuleManager::GetFunctionInformation | ( | const NXString & | functionName, |
| const NXString & | instanceOrClassName, | ||
| bool | isInstance, | ||
| bool | briefOnly | ||
| ) |
Get information about a function.
| functionName | Function name |
| instanceOrClassName | Instance or class name (used only for a method otherwise null or Nothing |
| isInstance | TRUE if instance name passed, FALSE otherwise |
| briefOnly | TRUE if returning brief information only |
| NXOpen::RuleManager::FunctionInformation NXOpen::RuleManager::GetFunctionInformation | ( | const char * | functionName, |
| const char * | instanceOrClassName, | ||
| bool | isInstance, | ||
| bool | briefOnly | ||
| ) |
Get information about a function.
| functionName | Function name |
| instanceOrClassName | Instance or class name (used only for a method otherwise null or Nothing |
| isInstance | TRUE if instance name passed, FALSE otherwise |
| briefOnly | TRUE if returning brief information only |
| std::vector<NXString> NXOpen::RuleManager::GetFunctions | ( | NXOpen::RuleManager::Filter | filter, |
| bool | doSort | ||
| ) |
Get functions that match the specified filter.
| filter | filter for functions |
| doSort | TRUE to get the functions sorted alphabetically |
| std::vector<NXString> NXOpen::RuleManager::GetLastError | ( | ) |
Get messages for the most recent error.
| NXString NXOpen::RuleManager::GetNameChain | ( | NXOpen::NXObject * | ugObject | ) |
Returns the name chain.
| ugObject | object to find name chain |
| NXString NXOpen::RuleManager::GetObjectText | ( | NXOpen::NXObject * | ugObject | ) |
Get the text to use when referencing the specified ug object in a rule.
| ugObject | object to find object text for |
| NXString NXOpen::RuleManager::GetParameterFormula | ( | const NXString & | referenceChain, |
| const NXString & | parameterName | ||
| ) |
Get the formula for a parameter that has been specified on a dynamic child rule.
| referenceChain | Reference chain for rule |
| parameterName | Parameter name |
| NXString NXOpen::RuleManager::GetParameterFormula | ( | const char * | referenceChain, |
| const char * | parameterName | ||
| ) |
Get the formula for a parameter that has been specified on a dynamic child rule.
| referenceChain | Reference chain for rule |
| parameterName | Parameter name |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetParameterType | ( | const NXString & | referenceChain | ) |
Get the type of a parameter in a dynamic child rule.
| referenceChain | Reference chain for rule |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetParameterType | ( | const char * | referenceChain | ) |
Get the type of a parameter in a dynamic child rule.
| referenceChain | Reference chain for rule |
| NXString 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 .
| ugObject | object to find reference text for |
| NXString NXOpen::RuleManager::GetRulesForObjects | ( | const std::vector< NXOpen::NXObject * > & | ugObjects | ) |
Adoption text for the specified ug objects.
| ugObjects | objects to adopt |
Get the names of all the rules defined in a class.
| className | Class name |
| std::vector<NXString> NXOpen::RuleManager::GetRulesOfClass | ( | const char * | className | ) |
Get the names of all the rules defined in a class.
| className | Class name |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetRuleType | ( | const NXString & | className, |
| const NXString & | ruleName | ||
| ) |
Get the type of a rule within a class.
| className | Class name |
| ruleName | Rule name within the class |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetRuleType | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Get the type of a rule within a class.
| className | Class name |
| ruleName | Rule name within the class |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetRuleType | ( | const NXString & | referenceChain | ) |
Get the data type of a dynamic rule.
| referenceChain | Reference chain for rule |
| NXOpen::RuleManager::RuleType NXOpen::RuleManager::GetRuleType | ( | const char * | referenceChain | ) |
Get the data type of a dynamic rule.
| referenceChain | Reference chain for rule |
| std::vector<NXString> NXOpen::RuleManager::GetRuleTypes | ( | ) |
Get strings that describe the rule types.
| std::vector<NXString> NXOpen::RuleManager::GetSpecifiedParameters | ( | const NXString & | referenceChain | ) |
Get the parameters that have been specified on a dynamic child rule.
| referenceChain | Reference chain for rule |
| std::vector<NXString> NXOpen::RuleManager::GetSpecifiedParameters | ( | const char * | referenceChain | ) |
Get the parameters that have been specified on a dynamic child rule.
| referenceChain | Reference chain for rule |
| NXOpen::RuleManager::InitializationStatusType NXOpen::RuleManager::Initialize | ( | NXOpen::RuleManager::LicenseType | licenseToTake, |
| int * | intentStatus | ||
| ) |
Initialize the RuleManager.
| licenseToTake | Which license to take |
| intentStatus | Status from initializing subsystem |
Returns whether a rule within a class is canonical.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsCanonical | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is canonical.
| className | Class name |
| ruleName | Rule name within the class |
Returns whether a rule within a class is a child list rule.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsChildList | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is a child list rule.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsChildList | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is a child list.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsChildList | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is a child list.
| referenceChain | Reference chain for rule |
Returns whether a rule in a class is a child rule.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsChildRule | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule in a class is a child rule.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsChildRule | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is a child rule.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsChildRule | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is a child rule.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsComputed | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule's value has been computed yet.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsComputed | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule's value has been computed yet.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsExpressionRule | ( | const NXString & | ruleName | ) |
Determine whether a root level dynamic rule is mapped to an NX expression.
| ruleName | Dynamic rule name |
| bool NXOpen::RuleManager::IsExpressionRule | ( | const char * | ruleName | ) |
Determine whether a root level dynamic rule is mapped to an NX expression.
| ruleName | Dynamic rule name |
Returns whether a rule within a class is hidden.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsHidden | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is hidden.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsHidden | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is hidden.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsHidden | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is hidden.
| referenceChain | Reference chain for rule |
Returns whether a rule within a class is local to that class.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsLocal | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is local to that class.
| className | Class name |
| ruleName | Rule name within the class |
Returns whether a rule within a class is a method.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsMethod | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is a method.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsMethod | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is a method.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsMethod | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is a method.
| referenceChain | Reference chain for rule |
Returns whether a rule within a class is modifiable.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsModifiable | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is modifiable.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsModifiable | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is modifiable.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsModifiable | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is modifiable.
| referenceChain | Reference chain for rule |
Returns whether a rule within a class is a parameter of that class.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsParameter | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is a parameter of that class.
| className | Class name |
| ruleName | Rule name within the class |
Returns whether the rule is defined in the specified class.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsRuleInClass | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether the rule is defined in the specified class.
| className | Class name |
| ruleName | Rule name within the class |
Returns whether a rule within a class is uncached.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsUncached | ( | const char * | className, |
| const char * | ruleName | ||
| ) |
Returns whether a rule within a class is uncached.
| className | Class name |
| ruleName | Rule name within the class |
| bool NXOpen::RuleManager::IsUncached | ( | const NXString & | referenceChain | ) |
Returns whether a dynamic rule is uncached.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsUncached | ( | const char * | referenceChain | ) |
Returns whether a dynamic rule is uncached.
| referenceChain | Reference chain for rule |
| bool NXOpen::RuleManager::IsUserClass | ( | const NXString & | className | ) |
Determine whether a class is a user class.
| className | Class name |
| bool NXOpen::RuleManager::IsUserClass | ( | const char * | className | ) |
Determine whether a class is a user class.
| className | Class name |
| bool NXOpen::RuleManager::IsUserFunction | ( | const NXString & | functionName | ) |
Determine whether a function is one defined by the user.
| functionName | Function name |
| bool NXOpen::RuleManager::IsUserFunction | ( | const char * | functionName | ) |
Determine whether a function is one defined by the user.
| functionName | Function name |
Read a dfa file and return its contents as a string.
| fileName | File name to read |
| NXString NXOpen::RuleManager::ReadDfaFile | ( | const char * | fileName | ) |
Read a dfa file and return its contents as a string.
| fileName | File name to read |
| 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 : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| void NXOpen::RuleManager::RegenerateAll | ( | ) |
Regenerate all rules.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| void NXOpen::RuleManager::Reload | ( | bool | refreshUserClassDir | ) |
Reload all classes and functions.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| refreshUserClassDir | flag for whether to refresh search dirs after load |
| void NXOpen::RuleManager::ReloadClassesAndFunctions | ( | std::vector< NXString > & | classes, |
| std::vector< NXString > & | functions | ||
| ) |
Reload specified classes and functions.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| classes | names of classes to reload |
| functions | names of functions to reload |
| void NXOpen::RuleManager::ReloadSingleClass | ( | const NXString & | className | ) |
Reload a single class.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| className | class name to reload |
| void NXOpen::RuleManager::ReloadSingleClass | ( | const char * | className | ) |
Reload a single class.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| className | class name to reload |
| void NXOpen::RuleManager::RemoveAllRules | ( | ) |
Remove all rules in the part.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| void NXOpen::RuleManager::RemoveRuleOnly | ( | const NXString & | referenceChain | ) |
Remove a dynamic child or attribute rule, but leave the geometry.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for rule to remove |
| void NXOpen::RuleManager::RemoveRuleOnly | ( | const char * | referenceChain | ) |
Remove a dynamic child or attribute rule, but leave the geometry.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for rule to remove |
Rename a dynamic child or attribute rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for rule to rename |
| newName | New leaf name |
| void NXOpen::RuleManager::Rename | ( | const char * | referenceChain, |
| const char * | newName | ||
| ) |
Rename a dynamic child or attribute rule.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| referenceChain | Reference chain for rule to rename |
| newName | New leaf name |
| void NXOpen::RuleManager::SetDebugFlag | ( | bool | debugFlag | ) |
Sets the debug update flag.
Created in NX5.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author")
| debugFlag | debug flag |
| void NXOpen::RuleManager::SyntaxCheck | ( | const NXString & | fileName | ) |
Run the syntax check on a dfa file.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| fileName | dfa file to check NOTE: The full Unicode character set is not supported for this parameter. |
| void NXOpen::RuleManager::SyntaxCheck | ( | const char * | fileName | ) |
Run the syntax check on a dfa file.
Created in NX4.0.0.
License requirements : ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| fileName | dfa file to check NOTE: The full Unicode character set is not supported for this parameter. |
| tag_t NXOpen::RuleManager::Tag | ( | ) | const |
Returns the tag of this object.
| void NXOpen::RuleManager::WriteDfaFile | ( | const NXString & | fileName, |
| const NXString & | fileString, | ||
| bool | replace | ||
| ) |
Write a string out to a dfa file.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| fileName | File name to write |
| fileString | String to write to file |
| replace | if TRUE, replace the file if it exists |
| void NXOpen::RuleManager::WriteDfaFile | ( | const char * | fileName, |
| const char * | fileString, | ||
| bool | replace | ||
| ) |
Write a string out to a dfa file.
Created in NX4.0.0.
License requirements : ug_kf_execute ("UG/Knowledge Fusion - Execute") OR ug_kf_author ("UG/Knowledge Fusion - Author") OR pts_author ("Product Template Studio (Author)")
| fileName | File name to write |
| fileString | String to write to file |
| replace | if TRUE, replace the file if it exists |