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

Used to import a part into the work part. More...

Inheritance diagram for NXOpen::PartImporter:
NXOpen::Importer NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DestinationCoordinateSystemSpecificationType { DestinationCoordinateSystemSpecificationTypeWork, DestinationCoordinateSystemSpecificationTypeSpecified }
 Specifies the destination coordinate system specification. More...
 
enum  LayerOptionType { LayerOptionTypeWork, LayerOptionTypeOriginal }
 Specifies on which layer to import a part. More...
 

Public Member Functions

bool CreateNamedGroup ()
 Returns the Create Named Group flag. More...
 
NXOpen::NXMatrixDestinationCoordinateSystem ()
 Returns the destination coordinate system. More...
 
NXOpen::PartImporter::DestinationCoordinateSystemSpecificationType DestinationCoordinateSystemSpecification ()
 Returns the destination coordinate system specification. More...
 
NXOpen::Point3d DestinationPoint ()
 Returns the destination point. More...
 
bool ImportCamObjects ()
 Returns the Import CAM Objects flag. More...
 
bool ImportViews ()
 Returns the Import Views flag. More...
 
NXOpen::PartImporter::LayerOptionType LayerOption ()
 Returns the layer option. More...
 
double Scale ()
 Returns the scale. More...
 
void SetCreateNamedGroup (bool createNamedGroup)
 Sets the Create Named Group flag. More...
 
void SetDestinationCoordinateSystem (NXOpen::NXMatrix *destinationCoordinateSystem)
 Sets the destination coordinate system. More...
 
void SetDestinationCoordinateSystemSpecification (NXOpen::PartImporter::DestinationCoordinateSystemSpecificationType destinationCoordinateSystemSpecification)
 Sets the destination coordinate system specification. More...
 
void SetDestinationPoint (const NXOpen::Point3d &destinationPoint)
 Sets the destination point. More...
 
void SetImportCamObjects (bool importCamObjects)
 Sets the Import CAM Objects flag. More...
 
void SetImportViews (bool importViews)
 Sets the Import Views flag. More...
 
void SetLayerOption (NXOpen::PartImporter::LayerOptionType layerOption)
 Sets the layer option. More...
 
void SetScale (double scale)
 Sets the scale. More...
 
void SetSpecifiedCoordinateSystem (NXOpen::CoordinateSystem *specifiedCoordinateSystem)
 Sets the specified coordinate system. More...
 
void SetSpecifiedCoordinateSystem (NXOpen::CoordinateSystem *specifiedCoordinateSystem, bool deleteSpecifiedCoordinateSystem)
 Sets the specified coordinate system. More...
 
- Public Member Functions inherited from NXOpen::Importer
NXString FileName ()
 Returns the name of the file containing the data to import. More...
 
void SetFileName (const NXString &fileName)
 Sets the name of the file containing the data to import. More...
 
void SetFileName (const char *fileName)
 Sets the name of the file containing the data to import. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Used to import a part into the work part.

The imported part can be an NX part or a foreign part, e.g. an I-DEAS, CATIA, or Teamcenter Visualization part. A named group will be created with the contents of the imported part if the property NXOpen::PartImporter::CreateNamedGroup and NXOpen::PartImporter::SetCreateNamedGroup is turned on. You can access the named group which is created when importing the part by accessing the object array returned from the method Builder::GetCommittedObjects after you execute the Builder::Commit on the NXOpen::PartImporter .
To obtain an instance of this class use ImportManager::CreatePartImporter .

Created in NX5.0.0.

Member Enumeration Documentation

Specifies the destination coordinate system specification.


Created in NX5.0.0.

Enumerator
DestinationCoordinateSystemSpecificationTypeWork 

Use Work Coordinate System.

DestinationCoordinateSystemSpecificationTypeSpecified 

Use specified coordinate system.

Specifies on which layer to import a part.


Created in NX5.0.0.

Enumerator
LayerOptionTypeWork 

Import part on work layer.

LayerOptionTypeOriginal 

Import part on original layers.

Member Function Documentation

bool NXOpen::PartImporter::CreateNamedGroup ( )

Returns the Create Named Group flag.

True if the Create Named Group flag is on.


Created in NX5.0.0.

License requirements : None

NXOpen::NXMatrix* NXOpen::PartImporter::DestinationCoordinateSystem ( )

Returns the destination coordinate system.


Created in NX5.0.0.

License requirements : None

NXOpen::PartImporter::DestinationCoordinateSystemSpecificationType NXOpen::PartImporter::DestinationCoordinateSystemSpecification ( )

Returns the destination coordinate system specification.


Created in NX5.0.0.

License requirements : None

NXOpen::Point3d NXOpen::PartImporter::DestinationPoint ( )

Returns the destination point.


Created in NX5.0.0.

License requirements : None

bool NXOpen::PartImporter::ImportCamObjects ( )

Returns the Import CAM Objects flag.

True if the Import CAM Objects flag is on.


Created in NX5.0.0.

License requirements : None

bool NXOpen::PartImporter::ImportViews ( )

Returns the Import Views flag.

True if the Import Views flag is on.


Created in NX5.0.0.

License requirements : None

NXOpen::PartImporter::LayerOptionType NXOpen::PartImporter::LayerOption ( )

Returns the layer option.


Created in NX5.0.0.

License requirements : None

double NXOpen::PartImporter::Scale ( )

Returns the scale.


Created in NX5.0.0.

License requirements : None

void NXOpen::PartImporter::SetCreateNamedGroup ( bool  createNamedGroup)

Sets the Create Named Group flag.

True if the Create Named Group flag is on.


Created in NX5.0.0.

License requirements : None

Parameters
createNamedGroupcreate named group
void NXOpen::PartImporter::SetDestinationCoordinateSystem ( NXOpen::NXMatrix destinationCoordinateSystem)

Sets the destination coordinate system.


Created in NX5.0.0.

License requirements : None

Parameters
destinationCoordinateSystemdestination coordinate system
void NXOpen::PartImporter::SetDestinationCoordinateSystemSpecification ( NXOpen::PartImporter::DestinationCoordinateSystemSpecificationType  destinationCoordinateSystemSpecification)

Sets the destination coordinate system specification.


Created in NX5.0.0.

License requirements : None

Parameters
destinationCoordinateSystemSpecificationdestination coordinate system specification
void NXOpen::PartImporter::SetDestinationPoint ( const NXOpen::Point3d destinationPoint)

Sets the destination point.


Created in NX5.0.0.

License requirements : None

Parameters
destinationPointdestination point
void NXOpen::PartImporter::SetImportCamObjects ( bool  importCamObjects)

Sets the Import CAM Objects flag.

True if the Import CAM Objects flag is on.


Created in NX5.0.0.

License requirements : None

Parameters
importCamObjectsimport cam objects
void NXOpen::PartImporter::SetImportViews ( bool  importViews)

Sets the Import Views flag.

True if the Import Views flag is on.


Created in NX5.0.0.

License requirements : None

Parameters
importViewsimport views
void NXOpen::PartImporter::SetLayerOption ( NXOpen::PartImporter::LayerOptionType  layerOption)

Sets the layer option.


Created in NX5.0.0.

License requirements : None

Parameters
layerOptionlayer option
void NXOpen::PartImporter::SetScale ( double  scale)

Sets the scale.


Created in NX5.0.0.

License requirements : None

Parameters
scalescale
void NXOpen::PartImporter::SetSpecifiedCoordinateSystem ( NXOpen::CoordinateSystem specifiedCoordinateSystem)

Sets the specified coordinate system.

This specified coordinate system is deleted after setting the destination coordinate system
Created in NX8.0.0.

License requirements : None

Parameters
specifiedCoordinateSystemspecified coordinate system
void NXOpen::PartImporter::SetSpecifiedCoordinateSystem ( NXOpen::CoordinateSystem specifiedCoordinateSystem,
bool  deleteSpecifiedCoordinateSystem 
)

Sets the specified coordinate system.

This provides an option whether to delete the specified coordinate system. If not mark for delete then it is user's responsibility to delete the specified coordinate system.
Created in NX8.0.1.

License requirements : None

Parameters
specifiedCoordinateSystemspecified coordinate system
deleteSpecifiedCoordinateSystemIf true, the specified coordinate system is deleted.

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