NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::GeometricUtilities::EntityUsageInfo Class Reference

Represents a NXOpen::GeometricUtilities::EntityUsageInfo . More...

Inheritance diagram for NXOpen::GeometricUtilities::EntityUsageInfo:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Status { StatusUnused, StatusIntraPart, StatusInterPart }
 enum for usage status More...
 

Public Member Functions

NXOpen::DisplayableObjectEntity ()
 Returns the important entity. More...
 
void GetDependentFeatures (NXOpen::GeometricUtilities::EntityUsageInfo::Status typeOfUsage, std::vector< NXOpen::Features::Feature * > &dependentFeatures, std::vector< NXString > &detailedUsageInfo)
 Query the dependent features of this entity. More...
 
void GetOtherDependents (NXOpen::GeometricUtilities::EntityUsageInfo::Status typeOfUsage, std::vector< NXOpen::NXObject * > &otherDependents, std::vector< NXString > &detailedUsageInfo)
 Query other dependents of this entity. More...
 
NXOpen::GeometricUtilities::EntityUsageInfo::Status UsageStatus ()
 Returns the usage status of the corresponding entity
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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 (see NXOpen::GeometricUtilities::ReplAsstBuilder ).


Created in NX6.0.0.

Member Enumeration Documentation

enum for usage status

Enumerator
StatusUnused 

unused

StatusIntraPart 

used in same part

StatusInterPart 

used interpart

Member Function Documentation

NXOpen::DisplayableObject* NXOpen::GeometricUtilities::EntityUsageInfo::Entity ( )

Returns the important entity.


Created in NX6.0.0.

License requirements : None

void NXOpen::GeometricUtilities::EntityUsageInfo::GetDependentFeatures ( NXOpen::GeometricUtilities::EntityUsageInfo::Status  typeOfUsage,
std::vector< NXOpen::Features::Feature * > &  dependentFeatures,
std::vector< NXString > &  detailedUsageInfo 
)

Query the dependent features of this entity.

Use 'typeOfUsage' to restrict the query to intra-part features or to include interpart features too.
Created in NX6.0.0.

License requirements : None

Parameters
typeOfUsagedesired level of usage information
dependentFeaturesdependent features
detailedUsageInfodetailed usage information for each dependent feature
void NXOpen::GeometricUtilities::EntityUsageInfo::GetOtherDependents ( NXOpen::GeometricUtilities::EntityUsageInfo::Status  typeOfUsage,
std::vector< NXOpen::NXObject * > &  otherDependents,
std::vector< NXString > &  detailedUsageInfo 
)

Query other dependents of this entity.

Use 'typeOfUsage' to restrict the query to intra-part dependents or to include interpart usage too.
Created in NX6.0.0.

License requirements : None

Parameters
typeOfUsagedesired level of usage information
otherDependentsdependent objects
detailedUsageInfodetailed usage information for each dependent object
NXOpen::GeometricUtilities::EntityUsageInfo::Status NXOpen::GeometricUtilities::EntityUsageInfo::UsageStatus ( )

Returns the usage status of the corresponding entity
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::EntityUsageInfo::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.