Standard Methods

Method used to return an object from a path. You must indicate the location of what you are looking for.

Feature.Access(Path: String, Type: String) : UndefinedType

UndefinedType

Feature.AccessFederatedExtension()

Feature.AccessFederatedExtension(typeName : String) : UndefinedType

UndefinedType

Feature.ActivateInactivateFeature()

Feature.ActivateInactivateFeature(activate : Boolean)

Method used to add a Know-how Apps Components type or customer extensions to all mechanical features and products.

Feature.AddExtension(type: String) : UndefinedType

UndefinedType

P : Part
set t = p -> AddExtension("MyType")
if (t == NULL)
{
Message ("Cannot Add 'MyType'")
}
else
{
Message ("Type 'MyType' Added")
}

Method used to return the attribute type in the form of a string.

Feature.AttributeType(AttributeName: String) : String

String

let s=""
s= feat->AttributeType("MyAttribute")

Feature.ActivateInactivateFeature()

Feature.CheckProjDistAndNormVectDiff(OffsetFeature : Feature, ThickFeature : Feature, projectionDistance : Real, differenceAngle : Real) : Real

Real

Method used to delete an object when possible (for example, a point in a part). After the deletion, the variable that referenced the feature becomes Unset (NULL). The deletion may fail. In this case an error message is raised. The deletion may be not allowed in some cases (in business rules for example).

Feature.Delete()

Method used to find an object that is a child or a parent, that is of a given type, and that fulfills a condition. It stops when it finds the first object.

Feature.Find(Type: String, Condition: String, Down: Boolean) : UndefinedType

UndefinedType

Feature.GSDGetSurfaceOrientation()

Feature.GSDGetSurfaceOrientation() : Real

Real

Method used to return the value of a Boolean type parameter added to a given object by using the Engineering Rules Capture product. parameterName is the name of the Boolean type parameter. It must be put between quotation marks ("). This method enables you to read:

• The attributes added to parameters using the Parameters Explorer.
• The real attributes added to objects.
• The User Properties of a product.

Feature.GetAttributeBoolean(String) : Boolean

Boolean

Message ("The value of the Boolean.1 attribute of # is #",
PartBodyPad.1.Name(),
PartBodyPad.1->GetAttributeBoolean("Boolean.1"))

Method used to retrieve a date.

Feature.GetAttributeDate(String) : Date

Date

Message("#",DateFormat("%d:%m: %Y",  VarName.GetAttributeDate("C_created")))

Method used to return the value of an integer type parameter added to a given object using Engineering Rules Capture. parameterName is the name of the string type parameter. It must be put between quotation marks ("). This method enables you to read:

• The attributes added to parameters using the Parameters Explorer.
• The real attributes added to objects.
• The User Properties of a product.

Feature.GetAttributeInteger(String) : Integer

Integer

Integer.3=PartBodyHole.1 ->GetAttributeInteger("Integer.2")

Method used to read the attribute attributeName of the object and returns an object.

Feature.GetAttributeObject(String) : UndefinedType

UndefinedType

Method used to return the value of a real or Length (in m) type parameter added to a given object by using the Engineering Rules Capture product. parameterName is the name of the string type parameter. It must be put between quotation marks ("). This method enables you to read:

• The attributes added to parameters using the Parameters Explorer.
• The real attributes added to objects.
• The User Properties of a product.

Feature.GetAttributeReal(String) : Real

Real

Method used to return the value of a string type parameter added to a given object by using the Engineering Rules Capture product. parameterName is the name of the string type parameter. This method enables you to read:

• The attributes added to parameters using the Parameters Explorer.

• The real attributes added to objects.

• The User Properties of a product.

Feature.GetAttributeString(String) : String

String

String.2 =PartBodyPad.1 ->GetAttributeString("String.1") 

Method used to point values only. It inherits from Pointer.

Feature.GetAttributeValuePointer(AttributeName: String) : ValuePointer

ValuePointer

let x (ValuePointer)
x= H  -> GetAttributeValuePointer("Diameter")

Feature.GetInputElements()

Feature.GetInputElements() : List

List

Gets the implementing references with specification links.

Feature.GetListOfImplementingReferences(List of Implementing reference : List, List of HowToUsage attributes : List, List of specification links : List)

let MyRequirement(Feature)
let Listofspecificationlinks(List)
let ListofImplementingRef(List)
set MyRequirement = MyReq // [From Argument List, Provided by User Selection]
MyRequirement->GetListOfImplementingReferencesForGlobalSpecification(ListofImplementingRef,Listofspecificationlinks)
";

Gets the implementing references with global specification links.

Feature.GetListOfImplementingReferencesForGlobalSpecification(List of Implementing reference : List, List of specification links : List)

let MyRequirement(Feature)
let Listofspecificationlinks(List)
let ListofImplementingRef(List)
set MyRequirement = MyReq // [From Argument List, Provided by User Selection]
MyRequirement->GetListOfImplementingReferencesForGlobalSpecification(ListofImplementingRef,Listofspecificationlinks)
";

Method used to determine whether the attribute specified in the argument belongs to the object to which the method is applied, and if the attribute value is not NULL.

Feature.HasAttribute(String) : Boolean

Boolean

Boolean.2 = PartBodyHole.1->HasAttribute("Real.1")

Feature.IsADatumFeat()

Feature.IsADatumFeat() : Integer

Integer

Method used to determine whether the feature specified in the argument is the parent of the object to which the method is applied. featureName must be put between quotation marks (").

Feature.IsOwnedBy(owner: Feature) : Boolean

Boolean

Boolean.1=PartBodyHole.1->IsOwnedBy(PartBody)

Method used to indicate if the object passed in argument implements a given type.

Feature.IsSupporting(typeName: String) : Boolean

Boolean

H:Hole
H -> IsSupporting("TaperedHole") == true

Lets you access the update status of an object. Returns TRUE if the objects are updated, FALSE if not. This method should work on the following list of features:

• Mechanical Features
• Product Structure objects (References, Instances, Rep References, Rep Instances)
• Rulebase
• Constraint Satisfaction
• Parameter Set
• Relation Set
• Optimization

Feature.IsUpToDate() : Boolean

Boolean

Let prdToCheck(VPMReference)
prdToCheck = [...]

if (not(prdToCheck->IsUpToDate())) 
{
       Report(“Warning”,”Product was not up to date”,”Product # was not up to date”)
       prdToCheck->Update()
}

Method used to return a list of strings corresponding to the name of the available attributes for a given object. The generated list depends not only on the Object Type but also on the object itself. That is to say, this method may return attributes that have been added dynamically to the object, through the Parameter Explorer command or through the SetAttribute method.

When adding integer or string attributes to faces, this method returns the attributes names and the face default values: the Color, Name, UserInfoComment and the integers Layer, Transparency.

Be careful, ListAttributeNames and ListAttributesValuePointers methods are not recursive. It is required to call them from the parameter set that is the direct parent of the parameters you want to read.

Feature.ListAttributeNames(TypeFilter: String, DynamicOnly:
 Boolean) : List

List

let x(List)
let s=""
let sfinal = ""
x = Product -> ListAttributeNames ("String",false)
for s in x
{
sfinal = sfinal + Product -> GetAttributeString (s)
}

let attributes (List)
let pad(GeometricFeature)
let faces (List)
let face (CATFace)

set pad=PartBody\Pad.1
faces = pad->GetSubElements(2) 
set face = faces[1]

/* Create 2 attributes on a pad face */
face->SetAttributeInteger("IntegerAttr",5) /* Creates an integer attribute of value 5 */
face->SetAttributeString("StringAttr","Value1") /* Creates an integer attribute of value Value1 */

/* Modify attribute values */
face->SetAttributeInteger("IntegerAttr",9) 
face->SetAttributeString("StringAttr","NewValue")

/* Read and display attribute values */
Message("IntegerAttr " , face->GetAttributeInteger("IntegerAttr")) 
Message("AttrString " , face->GetAttributeString("StringAttr"))

/* List the attributes */	
attributes=face->ListAttributeNames("String",false) 
attributes=face->ListAttributeNames("Integer",false)

Feature.ListAttributesValuePointers()

Be careful, ListAttributeNames and ListAttributesValuePointers methods are not recursive. It is required to call them from the parameter set that is the direct parent of the parameters you want to read.

Feature.ListAttributesValuePointers(TypeFilter : String) : List

List

Method used to search for the features located below the feature to which it applies and that verifies the specified expression The objects found are added to the list. All the children are scanned, the direct ones and recursively in the tree.

Feature.Query(Type: String, Condition: String) :
 List

List

List.1=PartBody.Query("Hole","x.Diameter>50mm")

Feature.RemoveAttribute()

Feature.RemoveAttribute(String)

Method used to remove a Know-how Apps Components type or a customer extension from all mechanical features and products.

Feature.RemoveExtension(type: String) : Integer

Integer

p : Part
let NBRemoved(Integer)
NBRemoved = p -> RemoveExtension("MyType")
if NBRemoved > 0 { Message ("Type removed") }

Method used to assign the value specified in the second argument to the parameter whose name is specified in the first argument. parameterName is the name of the Boolean type parameter whose value is to be modified. It must be put between quotation marks ("). Booleanvalue is either TRUE or FALSE. It is created only if it can be created using the Parameters Explorer.

Feature.SetAttributeBoolean(String, Boolean)

if PartBodyPad.1Boolean.1 <> true
PartBodyPad.1->SetAttributeBoolean("Boolean.1", true)

Method used to set a date.

Feature.SetAttributeDate(String, Date)

Method used to assign the value specified in the second argument to the parameter whose name is specified in the first argument. parameterName is the name of the parameter whose value is to be modified. parameterName must be put between quotation marks ("). The unit used is the current one.

Feature.SetAttributeDimension(String, Real, String)

Method used to assign the value specified in the second argument to the parameter whose name is specified in the first argument. parameterName is the name of the integer type parameter whose value is to be modified. Put parameterName between quotation marks (").

Feature.SetAttributeInteger(String, Integer)

if PartBodyHole.1Integer.1 <> 3
PartBodyHole.1 ->SetAttributeInteger("Integer.1", 3)

Method used to write the attribute attributeName of the object with what is referenced by the pointer. It will allow passing literal to an object that needs to reference it (and that does not only need the value). It is also used to valuate list parameters and attributes.

Feature.SetAttributeObject(String, Feature)

Method used to assign the value specified in the second argument to the parameter whose name is specified in the first argument. parameterName is the name of the real type parameter whose value is to be modified. Put parameterName between quotation marks (").

Feature.SetAttributeReal(String, Real)

Method used to assign the value specified in the second argument to the parameter whose name is specified in the first argument. parameterName is the name of the string type parameter whose value is to be modified. parameterName and stringvalue must be put between quotation marks (").

Feature.SetAttributeString(String, String)

if PartBodyPad.1->GetAttributeString("String.1") <> "String1"
PartBodyPad.1 ->SetAttributeString("String.1","This is a test")

/*Another syntax for the same rule is:*/

if PartBodyPad.1String.1 <> "String1"
PartBodyPad.1->SetAttributeString("String.1","This is a test")

Method used to update a feature when necessary. It is available on relations sets, parameters sets, parameters, rule bases, constraints satisfactions, optimizations, and Knowledge pattern features. It is unavailable on the objects such as geometric features.

Feature.Update()

Expression1 (P: #In PartFeature)
{
/* Finding a value */ 
let L (List) L = P -> Query(Rulebase,)
L -> Apply (RuleBase,x -> Update())
}

Method used to add an item to the list. If the index is equal to 0, the new item is added at the end of the list. If the index is equal to 1, the new item is inserted into the list at the location indicated by the index, meaning that the item is replaced with the new one and is therefore removed from the list. It is recommended to use the InsertItem method.

List.AddItem(Object: ObjectType, Index: Integer)

let list (List) 
						list -> AddItem(PartBody\Hole.2 ,1) 
						list -> AddItem(PartBodyHole.3 ,2) 
						Message("#",list.Size())

List.AdvancedSort()

List.AdvancedSort(Type : String, OperatorList : List, FormatList : List, ExpressionList : List) : List

List

Method used to add an item at the end of the list.

List.Append(Object: ObjectType)

Method used to apply a given expression to the objects of a list that are of a given type.In this expression, the element of the list is represented by a variable named x.

List.Apply(Type: String, Expression: String)

//Finds all rule bases and executes them 
//P being Part Feature 
/* Finding a value */  
						
let L (List)
L = P  ->  Query("Rulebase","")
L   ->   Apply ("RuleBase","x -> Update()")

Function used to compute the result of an operation performed all the elements of the list. It is available for Actions, Reactions and in Quality Rules Reuse. There are two usages for this method:

• On lists of values, it simply computes an operation on the values (+, min, max)
• On list of objects, it will compute an operation on results of expressions on the object.

List.Compute(Operation: String, Type: String, 
Expression: String, Result: UndefinedType)

List.1 ->Compute("+","","",Length.1)

List.1 -> Compute("+","Hole","x.Diameter+x.Depth",Length.1)

Method used to extract the items of a given type.

List.Extract(Type: String, TypeOutput: String,
 Expression: String) : List

List

Let L1(List) 
						Let L2(List) 
						... 
						L2=L1 -> Extract("Hole","LENGTH","y=x.Diameter+x.Depth")

Method used to filter a list of objects by extracting the objects that fulfill a Boolean expression.

List.Filter(Type: String, Condition: String) : List

List

I = (List -> Filter("Hole","x.Diameter > 3mm")).Size() 
						I = (List -> Filter("Hole","")).Size()

Method used to retrieve a value/item from the list. (Index from 1).

List.GetItem(Index: Integer) : UndefinedType

UndefinedType

Method used to return the first index of a list item. The item is searched for from the start index.

List.IndexOf(Element: ObjectType, StartIndex: Integer) : Integer

Integer

Method used to determine the content of alist. It lets you fill in the list with n identical items. This method lets you quickly fill in a list of given values. The list can be used along with any value. When using a list as value argument, it is copied each time.

List.Init(nbValues : Integer, value : ObjectType)

let L1, L2 (List)
L2.Init(3, 0) // now L2 contains 0, 0, 0
L1.Init(2, L2) // now L1 contains two lists, each containing 0, 0, 0
L1[1][1] = 1 // now L1 contains 1 list with 1, 0, 0 and the other one 0, 0, 0

Method used to insert an item into the list.

List.InsertItem(Object: ObjectType, Index: Integer)

Method used to get the intersection of two lists of objects. Optional criteria can be used to get only objects that are in both lists and that respect the condition.

List1.Intersect(List2 : List [, Type : String, Expression : String]) : List

List

Example

Let L1, L2, L3 (List)
L3 = L1.Intersect(L2, “HOle”, “x.Diameter == 15mm”)

Note: L3 = L1.Intersect(L2) generates a result list containing {X1, X3, X6, X13, X15}. If the result is not refined using a criterion, the result is a simple intersection (with common elements) of the two lists.

Method used to find elements of a list that verifies a criterion between elements of this list and elements of another list.

List1.Junction(List2 : List, TypeList1 : String, TypeList2 : String, Expression : String) : List

List

Let L1, L2n L3 (List)
L3 = L1.Junction(L2, “Hole”, “Hole”, “x.Diameter == y.Depth AND y.Diameter > 10mm”)

Method used to empty the list.

List.RemoveAll()

Method used to modify the content of the list by extracting the duplicated elements. When the list references objects (features and parameters), it removes the duplicated reference to the objects. When the list references volatile values, it removes the equivalent values.

List.RemoveDuplicates()

Method used to remove an item from the list.Index is the location of the object to be removed in the list. The index starts at 1.

List.RemoveItem(Index: Integer)

Method used to move an element of the list referenced by its position to a new position. The position starts at 1.

List.ReorderItem(Current: Integer, Target: Integer) : UndefinedType

UndefinedType

Method used to replace an item in the list.

List.SetItem(Object: ObjectType, Index: Integer)

Method used to return the number of items contained in the list.

List.Size() : Integer

Integer

Method used to sort lists. It operates the sort based on a criteria that corresponds to an extraction (see previous method).

List.Sort(Operator: String, Type: String, TypeOutput: String, Expression: String) : List

List

NewList = HoleList  ->  Sort(">","LENGTH","LENGTH","y=x.Diameter")			

Method used to split a list in more than one list depending on criteria.

List.Split(Type : String, ReturnType : String, Expression : String) : List

List

Let L1, L3 (List) //we declare L3 as a list, but it is good to remember that L3 will be a list of lists.
L3 = L1.Split(“Hole”, “Length”, “y = x.Diameter”)

L1 = {Hole1, Hole2, Hole3, Hole4, Hole5, Hole6} 	
L3 = {ListA, ListB, ListC, ListD, ListE}

ListA = {10, 12, 8, 6}     
ListB = {Hole1, Hole5}	
ListC = {Hole2, Hole4}	    
ListD = {Hole3}	
ListE = {Hole6}

Method used to remove objects from a list depending on another list.

List1.Subtract(List2 : List [, Type : String, Expression : String]) : List

List

Example

Let L1, L2, L3 (List)
L3 = L1.Subtract(L2, “Hole”, “x.Diameter == 15mm”)

Note: The result of L3=L1.Subtract(L2) is the same as the "-" operator.

Operator used to remove objects from a list according to another one.

– (List1: List, List2: List): (List3: List)

let L1, L2, L3 (List)
L3 = L1-L2

List

Literal.IsDriving()

Literal.IsDriving() : Boolean

Boolean

The Add method is used to insert a key-value pair in the map.

Map.Add(iKey : ObjectType, iValue : ObjectType) : Boolean

Boolean

// Creates a Map
let mapObj (Map)
mapObj = CreateMap(“String”, “String”)

// Defines Key
let iKey (String)
iKey = "Dimension"

// Defines Value
let iValue (string)
iValue = “Length”

// Defines output Boolean
let isPairAdded (Boolean)

// Using Add Method
isPairAdded = mapObj -> Add(iKey, iValue)

The Get method retrieves the value corresponding to the respective key present in the map.

Map.Get(iKey : ObjectType) : UndefinedType

UndefinedType

// Creates a Map
let mapObj (Map)
mapObj = CreateMap(“String”, “String”)

// Defines Key
let iKey (String)
iKey = "Dimension"

// Defines Value
let iValue (String)
iValue = “Length”

// Defines output Boolean
let isPairAdded (Boolean)

// Defines output Value
let oValue (String)

// Using Add Method
isPairAdded = mapObj -> Add(iKey, iValue)

// Using Get Method
oValue = mapObj -> Get(iKey)

The Remove method is used to delete the entry of the key-value pair present in the map.

Map.Remove(iKey : ObjectType) : Boolean

Boolean

// Creates a Map
let mapObj (Map)
mapObj = CreateMap(“String”, “String”)

// Defines Key
let iKey (String)
iKey = "Dimension"

// Defines Value
let iValue (String)
iValue = “Length”

// Defines output Boolean
let isPairAdded (Boolean)

// Defines output Value
let oValue (String)

//Defines the output if entry got removed or not
let isRemoved (Boolean)

// Using Add Method
isPairAdded = mapObj -> Add(iKey, iValue)

// Using Get Method
oValue = mapObj -> Get(iKey)

// Using Remove Method
isRemoved = mapObj ->Remove(iKey)

The Replace method updates the value of input key present in the map.

Map.Replace(iKey : ObjectType, iUpdateValue : ObjectType) : Boolean

Boolean

// Creates a Map
let mapObj (Map)
mapObj = CreateMap(“String”, “String”)

// Defines Key
let iKey (String)
iKey = "Dimension"

// Defines Value
let iValue (String)
iValue = “Length”

// Defines output Boolean
let isPairAdded (Boolean)

// Defines output Value
let oValue (String)

// Defines Value to be replaced by
let iUpdateValue (String)
iUpdateValue = “Breadth”

// Defines output if replaced or not
let isReplaced (Boolean)

// Using Add Method
isPairAdded = mapObj -> Add(iKey, iValue)

// Using Get Method
oValue = mapObj -> Get(iKey)

// Using Replace Method
isReplaced = mapObj ->Replace(iKey, iUpdateValue)

The ToLists method is used to segregate the keys and values of the map to different lists.

Map.ToLists(oKeyList : List, oValueList : List)

// Creates a Map
let mapObj (Map)
mapObj = CreateMap(“String”, “String”)

// Defines Key
let iKey (String)
iKey = "Dimension"

// Defines Value
let iValue (String)
iValue = “Length”

// Defines output Boolean
let isPairAdded (Boolean)

// Defines list to store keys of the map
let oKeyList (List)

// Defines list to store values of the map
let oValueList (List)
 
// Using Add Method
isPairAdded = mapObj -> Add(iKey, iValue)

// Using ToLists Method
mapObj -> ToLists (oKeyList, oValueList)

Method used to modify the the object referenced by the pointer. A pointer is a variable referencing an object. T

Pointer.SetValue(Value: ObjectType)

x = Hole -> GetAttributeValuePointer ("Diameter")
x -> SetValue(3mm) /* values the hole diameter */

Pointer.ValuatePointer()

Pointer.ValuatePointer(iStartObject : ObjectType, iBind : String, type : String)

String.MatchPattern()

String.MatchPattern(iPattern : String) : Boolean

Boolean

Checks if the given string matches the pattern and returns TRUE if it does, and FALSE if it does not.

String.MatchPattern(iPattern : String) : Boolean

Boolean

let referenceString = "testString12345678"
let patternToMatch = "test...ing[1-8]{8}"
Notify(referenceString+" matches "+ patternToMatch +" = #",referenceString.MatchPattern(patternToMatch))
patternToMatch = "test...ing[1-8]{7}"
Notify(referenceString+" matches "+ patternToMatch +" = #",referenceString.MatchPattern(patternToMatch))
patternToMatch = "test...ing[1-5]{8}"
Notify(referenceString+" matches "+ patternToMatch +" = #",referenceString.MatchPattern(patternToMatch))
patternToMatch = ".*1[2-8]*"
Notify(referenceString+" matches "+ patternToMatch +" = #",referenceString.MatchPattern(patternToMatch))

testString12345678 matches ...ing[1-8]{8} = true
testString12345678 matches ...ing[1-8]{7} = false
testString12345678 matches ...ing[1-5]{8} = false
testString12345678 matches .*1[2-8]* = true

Searches for an occurrence of the pattern in the string and returns it.

String.SearchPattern(iPattern : String) : String

String

let referenceString = "test1test2test3test4"
let patternToSearch = "....1"
Notify("Searching "+ patternToSearch +" in "+referenceString+" found #",referenceString.SearchPattern(patternToSearch))
patternToSearch = "(test[2-9]){2}"
Notify("Searching "+ patternToSearch +" in "+referenceString+" found #",referenceString.SearchPattern(patternToSearch))

Searching .... 1 in test1test2test3test4 found test1
Searching (test[2-9]){2} in test1test2test3test4 found test2test3