Helix Class¶
-
class
NXOpen.Features.Helix¶ Bases:
NXOpen.Features.FeatureRepresents a helix feature
To create or edit an instance of this class, use
NXOpen.Features.HelixBuilderNew in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| AlgorithmVersion | Returns the algorithm version of the feature |
| ContainerFeature | Returns the container feature for this feature. |
| FeatureType | Returns the feature type |
| IsContainedFeature | Returns true if the feature is a contained feature. |
| IsInternal | Returns true if the feature is internal. |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Location | Returns the location of the feature |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Suppressed | Returns the suppression status of the feature |
| Tag | Returns the Tag for this object. |
| Timestamp | Returns the timestamp of the feature |
Methods¶
| Method | Description |
|---|---|
| ChangeBooleanType | Change Boolean Type |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| DeleteClueAlerts | Delete all clue alerts from the features |
| DeleteHintAlerts | Delete all clue alerts from the features |
| DeleteInformationalAlerts | Delete all informational alerts from the features |
| DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
| DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
| DeleteWarningAlerts | Delete all warning alerts from the features |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAllChildren | Returns all immediate child features @return |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetChildren | Returns the immediate child features @return |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetEntities | Returns the entities created by the feature @return |
| GetExpressions | Returns the expressions created by the feature @return |
| GetFeatureClueHintMessages | Returns both clue and hint messages of the feature. |
| GetFeatureClueMessages | Returns the feature clue messages. |
| GetFeatureColor | The feature color @return |
| GetFeatureErrorMessages | Returns the feature error messages. |
| GetFeatureHintMessages | Returns the feature hint messages. |
| GetFeatureInformationalMessages | Returns the feature informational messages. |
| GetFeatureName | Returns the displayed name of the feature. |
| GetFeatureWarningMessages | Returns the feature warning messages. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetParents | Returns the immediate parent features @return |
| GetRealAttribute | Gets a real attribute by title. |
| GetRealUserAttribute | Gets a real attribute by Title and array Index. |
| GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
| GetSections | Queries a feature for list of its sections @return Array of sections |
| GetStringAttribute | Gets a string attribute value by title. |
| GetStringUserAttribute | Gets a string attribute by Title and array Index. |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
| GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
| GetUserAttributeCount | Gets the count of set attributes on the object, if any, of the given type. |
| GetUserAttributeLock | Determine the lock of the given attribute. |
| GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
| GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
| GetUserAttributes | Gets all the attributes that have been set on the given object. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
| HideBody | Hide the body created by the feature |
| HideParents | Hide the body created by the parent feature |
| Highlight | Highlight the body created by the feature |
| LogDiagnostic | Log a diagnostic alert for this feature |
| MakeCurrentFeature | Make current feature |
| MakeSketchExternal | Make the parent sketch external for reuse by other features. |
| MakeSketchInternal | Make the parent sketch internal if referenced only by this feature. |
| Prints a representation of this object to the system log file. | |
| RemoveForEdit | Remove all the feature faces before a NoHistory mode edit. |
| RemoveParameters | Remove Local feature parameters in history free mode. |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetGroupActive | Set a feature group as active group. |
| SetName | Sets the custom name of the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| SetTimeAttribute | Creates or modifies a time attribute. |
| SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
| SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
| SetUserAttributeLock | Lock or unlock the given attribute. |
| ShowBody | Show the body created by the feature |
| ShowDimensions | Show all feature dimensions of a feature. |
| ShowParents | Show the body created by the parent feature |
| Suppress | Suppress the feature |
| Unhighlight | Unhighlight the body created by the feature |
| Unsuppress | Unsuppress the feature |
Property Detail¶
IsOccurrence¶
-
Helix.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrence()Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
Helix.JournalIdentifier¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------Getter Method
Signature
JournalIdentifier()Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
Helix.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
Name()Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
Helix.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponent()Returns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
Helix.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPart()Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
Helix.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
Prototype()Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
Helix.FindObject¶ Finds the
NXOpen.NXObjectwith the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Print¶
-
Helix.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
Helix.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.