Feature

This page explains the different functions of Attributes and Methods.

Attributes

This section provides you with information about Attributes.

Attribute Function
Id Defines the feature identifier, i.e. the name primarily assigned to the feature at creation before any renaming has been done.
Owner Defines the parent feature.
Name Defines the feature name.
NamedURLs Describes the URL that the user can add to a relation by clicking the Comment and URLs icon in the Knowledge Advisor workbench.
UserInfoComment Describes the comment that the user can add in the Comment and URLs dialog box when adding a URL to a relation in Knowledge Advisor.
Children Lists the objects aggregated under an object.
Feature > Layer Method allowing you to get/set the layer associated with a feature.

Example


  1. Create a part with several holes.
  2. Add a real type parameter ("Real.1" for example) to one of the hole features. To do this, use the Parameter Explorer in the Knowledge Advisor product.

  3. Create the rule below:

    /* This rule resets the diameter of the hole */ /*
Hole is the type*/ /* which has "Real.1" as its parameter to the Real.1 value */ (for all) H:Hole
 if H > HasAttribute("Real.1") H.Diameter = 1mm*(H > GetAttributeReal("Real.1"))

Methods

This section provides you with information about Methods.

Method Function Syntax Example
AttributeType Returns the attribute type in the form of a string.    
GetAttributeBoolean   Returns the value of a boolean type parameter added to a given feature by using the Knowledge Advisor 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.

Unless you know perfectly that your feature has an attribute xxx, use before the HasAttribute method.

feature.Get AttributeBoolean (String):Boolean

where the argument is the name of the attribute.

Message ("The value of the Boolean.1 attribute of # is #", PartBody\Pad.1.Name(), PartBodyPad.1.GetAttributeBoolean("Boolean.1"))
GetAttributeInteger Returns the value of an integer type parameter added to a given feature using Knowledge Advisor. 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.Get AttributeInteger (String):Integer

where String is name of the attribute. This name must be put between double-quotes.

Integer.3=PartBody Hole.1 .GetAttributeInteger ("Integer.2")

GetAttributeReal Returns the value of a real or Length (in m) type parameter added to a given feature by using the Knowledge Advisor 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.Get AttributeReal (String): String

where String is name of the attribute. This name must be put between double-quotes.		  
GetAttributeString Returns the value of a string type parameter added to a given feature by using the Knowledge Advisor 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.Get AttributeString (String): String

where String is name of the attribute. This name must be put between double-quotes.

String.2 =PartBody Pad.1 .GetAttributeString ("String.1")
GetAttributeObject Reads the attribute attributeName of the object and returns an object.

feature.Get AttributeObject (String): Feature

where String is name of the attribute. This name must be put between double-quotes.		  
HasAttribute Determines whether the attribute specified in the argument belongs to the feature to which the method is applied.

feature. HasAttribute(String): Boolean

where String is name of the attribute. This name must be put between double-quotes

Boolean.2 =PartBodyHole.1. HasAttribute("Real.1")
Id Obsolete. You can now use the Id attribute.    
IsOwnedBy Determines whether the feature specified in the argument is the parent of the feature to which the method is applied. featureName must be put between quotation marks (").

feature.IsOwn edBy(): Boolean

Boolean.1=PartBody Hole.1.IsOwnedBy(PartBody)
IsSupporting Function indicating if the object passed in argument implements a given type.

H:Hole H > IsSupport ("TaperedHole") == true

 
Name Obsolete. You can now use the Name attribute.    
SetAttributeBoolean Assigns 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.SetAttribute Boolean(String, Boolean): Void

where the first argument is name of the attribute and the second is the value to be assigned to it.		 if PartBodyPad.1 Boolean.1 <> true PartBodyPad.1. SetAttributeBoolean ("Boolean.1", true)
SetAttributeInteger Assigns 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. SetAttributeIntege (String, Integer): Void

 if PartBodyHole.1 Integer.1 <> 3 PartBodyHole.1 . SetAttributeInteger ("Integer.1", 3)
SetAttributeReal Assigns 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):

where String is name of the attribute and Real the value to be assigned to the parameter (MKS dimensions).		 if PartBodyHole.1 Real.1 <> 3 PartBodyHole.1 .SetAttributeReal("Real.1",3)
SetAttributeString Assigns 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): Void

where the first argument is name of the attribute and the second is the value to be assigned to it.

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.1 String.1 <> "String1" PartBodyPad.1. SetAttributeString ("String.1","This is a test")
SetAttributeInteger Assigns 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. parameterName must be put between quotation marks (").

feature. SetAttributeInteger (String, Integer): Void

where the first argument is name of the attribute and the second is the value to be assigned to it.

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

SetAttributeDimension Assigns 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) : Void Type

where the first argument is name of the attribute, the second is the value to be assigned to it and the third is the type.		  
SetAttributeObject Writes the attribute attributeName of the object with what is referenced by the pointer o It will allow to pass literal to an object that needs to reference it (and that does not only need the value).

feature. SetAttributeObject (String, Feature): VoidType

  
Update Performs the update of a feature when necessary. It is available on relations sets, parameters sets, parameters, rule bases, constraints satisfactions, optimizations, and Knowledge pattern features. It has no impacts on the other objects.

feature.Update(): VoidType

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