EntityUsageInfo Class¶
-
class
NXOpen.GeometricUtilities.
EntityUsageInfo
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.GeometricUtilities.EntityUsageInfo
.An object of this class provides the dependency information for a single reparentable entity (edge or face). The creation of
NXOpen.GeometricUtilities.EntityUsageInfo
is restricted for internal use (seeNXOpen.GeometricUtilities.ReplAsstBuilder
).New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Entity | Returns the important entity. |
Tag | Returns the Tag for this object. |
UsageStatus | Returns the usage status of the corresponding entity |
Methods¶
Method | Description |
---|---|
GetDependentFeatures | Query the dependent features of this entity. |
GetOtherDependents | Query other dependents of this entity. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
EntityUsageInfoStatus Enumeration | enum for usage status |
Property Detail¶
Entity¶
-
EntityUsageInfo.
Entity
¶ Returns the important entity.
-------------------------------------
Getter Method
Signature
Entity()
Returns: Return type: NXOpen.DisplayableObject
New in version NX6.0.0.
License requirements: None.
UsageStatus¶
-
EntityUsageInfo.
UsageStatus
¶ Returns the usage status of the corresponding entity
-------------------------------------
Getter Method
Signature
UsageStatus()
Returns: Return type: NXOpen.GeometricUtilities.EntityUsageInfoStatus
New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetDependentFeatures¶
-
EntityUsageInfo.
GetDependentFeatures
¶ Query the dependent features of this entity.
Use ‘typeOfUsage’ to restrict the query to intra-part features or to include interpart features too.
Signature
GetDependentFeatures(typeOfUsage)
Parameters: typeOfUsage ( NXOpen.GeometricUtilities.EntityUsageInfoStatus
) – desired level of usage informationReturns: a tuple Return type: A tuple consisting of (dependentFeatures, detailedUsageInfo). dependentFeatures is a list of NXOpen.Features.Feature
. dependent features detailedUsageInfo is a list of str. detailed usage information for each dependent featureNew in version NX6.0.0.
License requirements: None.
GetOtherDependents¶
-
EntityUsageInfo.
GetOtherDependents
¶ Query other dependents of this entity.
Use ‘typeOfUsage’ to restrict the query to intra-part dependents or to include interpart usage too.
Signature
GetOtherDependents(typeOfUsage)
Parameters: typeOfUsage ( NXOpen.GeometricUtilities.EntityUsageInfoStatus
) – desired level of usage informationReturns: a tuple Return type: A tuple consisting of (otherDependents, detailedUsageInfo). otherDependents is a list of NXOpen.NXObject
. dependent objects detailedUsageInfo is a list of str. detailed usage information for each dependent objectNew in version NX6.0.0.
License requirements: None.
Validate¶
-
EntityUsageInfo.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.