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

Represents a NXOpen::GeometricUtilities::ParentEquivalencyMap . More...

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

Public Types

enum  Status { StatusIncomplete, StatusTentative, StatusAccepted }
 enum for map status More...
 
enum  Type {
  TypeUndefined, TypeUserDefined, TypeNameBased, TypeGeometric,
  TypeInferred, TypeInternal, TypeInherited, TypeMixed
}
 enum for map type More...
 

Public Member Functions

void GetEntitiesFromCurrentObject (std::vector< NXOpen::DisplayableObject * > &entitiesFromCurrentObject)
 Get the mapped entities from the current object. More...
 
void GetEntitiesFromReplacementObject (std::vector< NXOpen::DisplayableObject * > &entitiesFromReplacementObject)
 Get the mapped entities from the replacement object
Created in NX6.0.0. More...
 
NXOpen::GeometricUtilities::ParentEquivalencyMap::Status MapStatus ()
 Returns the map status
Created in NX6.0.0. More...
 
NXOpen::GeometricUtilities::ParentEquivalencyMap::Type MapType ()
 Returns the map type
Created in NX6.0.0. More...
 
void SetMappedEntities (const std::vector< NXOpen::DisplayableObject * > &oldEntities, const std::vector< NXOpen::DisplayableObject * > &newEntities)
 Set externally mapped entities
Created in NX6.0.0. More...
 
void SetMapStatus (NXOpen::GeometricUtilities::ParentEquivalencyMap::Status mapStatus)
 Sets the map status
Created in NX6.0.0. More...
 
void SetMapType (NXOpen::GeometricUtilities::ParentEquivalencyMap::Type mapType)
 Sets the map type
Created in NX9.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::ParentEquivalencyMap .

An object of this class represents a correspondence between entities of the current object (Linked / Extract feature being edited) and entities of the replacement object (faces / body).
To create a new instance of this class, use NXOpen::GeometricUtilities::ReplAsstBuilder::CreateEmptyMatch

Created in NX6.0.0.

Member Enumeration Documentation

enum for map status

Enumerator
StatusIncomplete 

incomplete

StatusTentative 

tentative

StatusAccepted 

accepted

enum for map type

Enumerator
TypeUndefined 

undefined

TypeUserDefined 

user defined or manual

TypeNameBased 

mapped by name

TypeGeometric 

mapped by geometric comparison

TypeInferred 

inferred from accepted

TypeInternal 

internal ID reuse

TypeInherited 

inherited from other part or operation

TypeMixed 

combination of multiple methods

Member Function Documentation

void NXOpen::GeometricUtilities::ParentEquivalencyMap::GetEntitiesFromCurrentObject ( std::vector< NXOpen::DisplayableObject * > &  entitiesFromCurrentObject)

Get the mapped entities from the current object.


Created in NX6.0.0.

License requirements : None

Parameters
entitiesFromCurrentObjectentities from the current object
void NXOpen::GeometricUtilities::ParentEquivalencyMap::GetEntitiesFromReplacementObject ( std::vector< NXOpen::DisplayableObject * > &  entitiesFromReplacementObject)

Get the mapped entities from the replacement object
Created in NX6.0.0.



License requirements : None

Parameters
entitiesFromReplacementObjectentities from the replacement object
NXOpen::GeometricUtilities::ParentEquivalencyMap::Status NXOpen::GeometricUtilities::ParentEquivalencyMap::MapStatus ( )

Returns the map status
Created in NX6.0.0.



License requirements : None

NXOpen::GeometricUtilities::ParentEquivalencyMap::Type NXOpen::GeometricUtilities::ParentEquivalencyMap::MapType ( )

Returns the map type
Created in NX6.0.0.



License requirements : None

void NXOpen::GeometricUtilities::ParentEquivalencyMap::SetMappedEntities ( const std::vector< NXOpen::DisplayableObject * > &  oldEntities,
const std::vector< NXOpen::DisplayableObject * > &  newEntities 
)

Set externally mapped entities
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
oldEntitiesentities from the current object
newEntitiesentities from the replacement object
void NXOpen::GeometricUtilities::ParentEquivalencyMap::SetMapStatus ( NXOpen::GeometricUtilities::ParentEquivalencyMap::Status  mapStatus)

Sets the map status
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
mapStatusmapstatus
void NXOpen::GeometricUtilities::ParentEquivalencyMap::SetMapType ( NXOpen::GeometricUtilities::ParentEquivalencyMap::Type  mapType)

Sets the map type
Created in NX9.0.0.



License requirements : None

Parameters
mapTypemaptype
virtual bool NXOpen::GeometricUtilities::ParentEquivalencyMap::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.