All ITK functions of group NR supported by T4x.
More...
|
| NR_ask_rule_and_case type_name property_name |
| This function calls the ITK pipe server function ITK_NR_ask_rule_and_case to get the Naming rule for a given object type and property. More...
|
|
| NR_next_value2 typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId |
| This function calls the ITK pipe server function ITK_NR_next_value2 to get the next Id for a given parameter set. Gets the next id generated for a particular pattern in the Naming Rule. This ITK is a generalized ITK for generating next id in case of :
- next item id
- next revision id
- next revision id generated from the pattern in the alt rule
- next alt id generated from the pattern in rule
- next dataset id
- next dataset revision id
- For any String attribute on a type.
More...
|
|
| NR_pattern_next_value typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId pattern |
| This function calls the ITK pipe server function ITK_NR_pattern_next_value to get the next Id for a given parameter set. Gets the next id generated for a particular input pattern in the Naming Rule This ITK is a generalized ITK for generating next id in case of :
- next item id
- next revision id
- next revision id generated from the pattern in the alt rule
- next alt id generated from the pattern in rule
- next dataset id
- next dataset revision id
- For any String attribute on a type.
More...
|
|
| NR_rule_desc_with_counters2 rule_tag |
| This function calls the ITK pipe server function ITK_NR_rule_desc_with_counters2 to get the rule description of a given rule tag. More...
|
|
All ITK functions of group NR supported by T4x.
This group specifies all ITK functions of group NR for which wrappers have been defined in T4x
◆ NR_ask_rule_and_case()
ITK::NR_ask_rule_and_case |
|
|
type_name property_name |
|
|
| |
This function calls the ITK pipe server function ITK_NR_ask_rule_and_case to get the Naming rule for a given object type and property.
- Parameters
-
type_name | The IMANTYPE that the rule applies to |
property_name | The property field in this IMANTYPE that the rule applies to |
- Returns
- list of ITK_ok (=0), rule_tag (Tag of NameRules object containing the rule patterns) and field_case (NR_CASE_MIXED, NR_CASE_LOWER, NR_CASE_UPPER) or list of ITK status and error message
Sample code sequence
2 puts "ItkStatus $ItkStatus"
4 set RuleTag [
lindex $ItkStatus 1]
5 if {[
string length $RuleTag] == 0} {
7 puts "XXXX No naming rule defined for $TypeName $PropertyName"
11 puts "XXXX Naming rule defined for $TypeName $PropertyName $RuleTag"
19 puts "XXXX Call to ITK function 'NR_ask_rule_and_case' failed! Error code: $ErrorNumber - $ErrorMesssage"
◆ NR_next_value2()
ITK::NR_next_value2 |
|
|
typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId |
|
|
| |
This function calls the ITK pipe server function ITK_NR_next_value2 to get the next Id for a given parameter set. Gets the next id generated for a particular pattern in the Naming Rule. This ITK is a generalized ITK for generating next id in case of :
- next item id
- next revision id
- next revision id generated from the pattern in the alt rule
- next alt id generated from the pattern in rule
- next dataset id
- next dataset revision id
- For any String attribute on a type.
- Parameters
-
typeName | Teamcenter Engineering type name, i.e. "Item" |
propertyName | Property name, i.e. "item_id", "item_revision_id", "object_name" |
itemTag | The tag of the parent item |
dsId | Dataser Id |
preferredTypeName | Prefrerred type Name |
defaultTypeName | Default type Name |
parentTag | Used in case of next alt id |
ruleSuffix | Used in case of next revision id generated from the pattern in the alt rule |
baseRevId | Used in case of next revision id generated from the pattern in the alt rule |
- Returns
- List of ITK_ok (=0), NextId and isNRWithoutAutogen (true or false) or list of ITK status and error message
Sample code sequence
2 puts "ItkStatus $ItkStatus"
5 puts "XXXX Call to ITK function 'NR_next_value2' returns: NewValue=[
lindex $ItkStatus 1] isNRWithoutAutogen=[
lindex $ItkStatus 2]"
12 puts "XXXX Call to ITK function 'NR_next_value2' failed! Error code: $ErrorNumber - $ErrorMesssage"
◆ NR_pattern_next_value()
ITK::NR_pattern_next_value |
|
|
typeName propertyName itemTag dsId preferredTypeName defaultTypeName parentTag ruleSuffix baseRevId pattern |
|
|
| |
This function calls the ITK pipe server function ITK_NR_pattern_next_value to get the next Id for a given parameter set. Gets the next id generated for a particular input pattern in the Naming Rule This ITK is a generalized ITK for generating next id in case of :
- next item id
- next revision id
- next revision id generated from the pattern in the alt rule
- next alt id generated from the pattern in rule
- next dataset id
- next dataset revision id
- For any String attribute on a type.
If pattern doesnot exist then next id will be NULL
- Parameters
-
typeName | Teamcenter Engineering type name, i.e. "Item" |
propertyName | Property name, i.e. "item_id", "item_revision_id", "object_name" |
itemTag | The tag of the parent item |
dsId | Dataser Id |
preferredTypeName | Prefrerred type Name |
defaultTypeName | Default type Name |
parentTag | Used in case of next alt id |
ruleSuffix | Used in case of next revision id generated from the pattern in the alt rule |
baseRevId | Used in case of next revision id generated from the pattern in the alt rule |
pattern | The input pattern for which the next id to be generated |
- Returns
- List of ITK_ok (=0) and NextId or list of ITK status and error message
Sample code sequence
2 puts "ItkStatus $ItkStatus"
4 set RuleTag [
lindex $ItkStatus 1]
5 if {[
string length $RuleTag] == 0} {
7 puts "XXXX No naming rule defined for $TypeName $PropertyName"
11 puts "ItkStatus $ItkStatus"
13 set RuleDescDict [
lindex $ItkStatus 1]
14 set n_patterns [dict get $RuleDescDict n_patterns]
15 if {$n_patterns > 1} {
16 puts "XXXX Try to get next Id for 1st pattern: $Pattern"
20 puts "XXXX Call to ITK function 'NR_pattern_next_value' returns: [
lindex $ItkStatus 1]"
27 puts "XXXX Call to ITK function 'NR_pattern_next_value' failed! Error code: $ErrorNumber - $ErrorMesssage"
36 puts "XXXX Call to ITK function 'NR_rule_desc_with_counters2' failed! Error code: $ErrorNumber - $ErrorMesssage"
45 puts "XXXX Call to ITK function 'NR_ask_rule_and_case' failed! Error code: $ErrorNumber - $ErrorMesssage"
◆ NR_rule_desc_with_counters2()
ITK::NR_rule_desc_with_counters2 |
|
|
rule_tag |
|
|
| |
This function calls the ITK pipe server function ITK_NR_rule_desc_with_counters2 to get the rule description of a given rule tag.
- Parameters
-
rule_tag | Tag of NameRules object |
- Returns
- list of ITK_ok (=0) and RuleDescriptorDict or list of ITK status and error message RuleDescriptorDict dict structure with the followingelements:
- rule_name name of the rule (e.g. Default Requirement ID Rule)
- n_patterns number of patterns
- patterns:1 .. n {"REQ-"nnnnnn}
- patterns_details:1 .. n sub dict that has the following elements autogen n_counters number of counters (1 .. n) counter_tags:1 .. n
Sample code sequence
2 puts "ItkStatus $ItkStatus"
4 set RuleTag [
lindex $ItkStatus 1]
5 if {[
string length $RuleTag] == 0} {
7 puts "XXXX No naming rule defined for $TypeName $PropertyName"
11 puts "ItkStatus $ItkStatus"
13 set RuleDescDict [
lindex $ItkStatus 1]
14 set n_patterns [dict get $RuleDescDict n_patterns]
15 if {$n_patterns > 1} {
16 for {
set Index 0} {$Index < $n_patterns} {
incr $Index} {
17 set Pattern [dict get $RuleDescDict patterns:$Index]
18 set PatternInfo [dict get $RuleDescDict patterns_details:$Index]
19 puts "->Pattern($Index) $Pattern"
20 puts "->PatternInfo($Index) $PatternInfo"
28 puts "XXXX Call to ITK function 'NR_rule_desc_with_counters2' failed! Error code: $ErrorNumber - $ErrorMesssage"
37 puts "XXXX Call to ITK function 'NR_ask_rule_and_case' failed! Error code: $ErrorNumber - $ErrorMesssage"