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

Represents a NXOpen::Step242Importer to be used when importing STEP242 Data This class is created using NXOpen::DexManager . More...

Inheritance diagram for NXOpen::Step242Importer:
NXOpen::DexBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ImportToOption { ImportToOptionWorkPart, ImportToOptionNewPart }
 What part to import to. More...
 
enum  MessageEnum {
  MessageEnumNone, MessageEnumInformational, MessageEnumWarning, MessageEnumError,
  MessageEnumDebug, MessageEnumAll
}
 Messages output when opening the file. More...
 

Public Member Functions

bool FileOpenFlag ()
 Returns the file open flag - set this to false if doing file import
Created in NX11.0.0. More...
 
bool FlattenAssembly ()
 Returns the flatten assembly - if set to true then assembly structure will not be retained
Created in NX11.0.0. More...
 
NXOpen::Step242Importer::ImportToOption ImportTo ()
 Returns the import to - this option will determine the destination for imported iges file. More...
 
bool ImportToTeamcenter ()
 Returns the ImportToTeamcenter command - if set to true then the assembly will be imported into Teamcenter
Created in NX11.0.0. More...
 
NXString InputFile ()
 Returns the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
NXOpen::Step242Importer::MessageEnum Messages ()
 Returns the message level for syslog messages when loading Step242 files
Created in NX11.0.0. More...
 
NXOpen::ObjectTypeSelectorObjectTypes ()
 Returns the objectTypes - this is subcomponent being used to set object types filters. More...
 
bool Optimize ()
 Returns the optimize - if set to true Optimizes geometry
Created in NX11.0.0. More...
 
NXString OutputFile ()
 Returns the output file - if iges file is imported to new part then this name will be used to write the output. More...
 
void SaveSettings (const NXString &filename)
 Saves the save settings - this will save the settings to a file specified
Created in NX11.0.0. More...
 
void SaveSettings (const char *filename)
 Saves the save settings - this will save the settings to a file specified
Created in NX11.0.0. More...
 
void SetFileOpenFlag (bool doingFileOpen)
 Sets the file open flag - set this to false if doing file import
Created in NX11.0.0. More...
 
void SetFlattenAssembly (bool flattenAssembly)
 Sets the flatten assembly - if set to true then assembly structure will not be retained
Created in NX11.0.0. More...
 
void SetImportTo (NXOpen::Step242Importer::ImportToOption importTo)
 Sets the import to - this option will determine the destination for imported iges file. More...
 
void SetImportToTeamcenter (bool importToTeamcenter)
 Sets the ImportToTeamcenter command - if set to true then the assembly will be imported into Teamcenter
Created in NX11.0.0. More...
 
void SetInputFile (const NXString &filename)
 Sets the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
void SetInputFile (const char *filename)
 Sets the input file - name of a file which is being imported
Created in NX11.0.0. More...
 
void SetMessages (NXOpen::Step242Importer::MessageEnum messages)
 Sets the message level for syslog messages when loading Step242 files
Created in NX11.0.0. More...
 
void SetOptimize (bool optimize)
 Sets the optimize - if set to true Optimizes geometry
Created in NX11.0.0. More...
 
void SetOutputFile (const NXString &filename)
 Sets the output file - if iges file is imported to new part then this name will be used to write the output. More...
 
void SetOutputFile (const char *filename)
 Sets the output file - if iges file is imported to new part then this name will be used to write the output. More...
 
void SetSettingsFile (const NXString &filename)
 Sets the settings file - definition file for default options
Created in NX11.0.0. More...
 
void SetSettingsFile (const char *filename)
 Sets the settings file - definition file for default options
Created in NX11.0.0. More...
 
void SetSewSurfaces (bool sewSurfaces)
 Sets the sew surfaces - if set to true surfaces will be sewed automatically
Created in NX11.0.0. More...
 
void SetSimplifyGeometry (bool simplifyGeometry)
 Sets the simplify geometry - if set to true geometry will be simplified automatically
Created in NX11.0.0. More...
 
void SetSmoothBSurfaces (bool smoothBSurfaces)
 Sets the Smooth B-Surfaces - if set to true smooth B-Surfaces
Created in NX11.0.0. More...
 
NXString SettingsFile ()
 Returns the settings file - definition file for default options
Created in NX11.0.0. More...
 
bool SewSurfaces ()
 Returns the sew surfaces - if set to true surfaces will be sewed automatically
Created in NX11.0.0. More...
 
bool SimplifyGeometry ()
 Returns the simplify geometry - if set to true geometry will be simplified automatically
Created in NX11.0.0. More...
 
bool SmoothBSurfaces ()
 Returns the Smooth B-Surfaces - if set to true smooth B-Surfaces
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::DexBuilder
bool ProcessHoldFlag ()
 Returns the process hold flag - set to true if user wants to wait until transaltion process gets completed
Created in NX8.0.0. More...
 
void SetProcessHoldFlag (bool doingFileSave)
 Sets the process hold flag - set to true if user wants to wait until transaltion process gets completed
Created in NX8.0.0. 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

Represents a NXOpen::Step242Importer to be used when importing STEP242 Data This class is created using NXOpen::DexManager .

NULL object will be returned from Commit()
To create a new instance of this class, use NXOpen::DexManager::CreateStep242Importer
Default values.

Property Value

FlattenAssembly

0

ImportTo

WorkPart

ImportToTeamcenter

0

Messages

None

Optimize

0

SewSurfaces

0

SimplifyGeometry

0

SmoothBSurfaces

1


Created in NX11.0.0.

Member Enumeration Documentation

What part to import to.

Enumerator
ImportToOptionWorkPart 

import STEP242 file to work part

ImportToOptionNewPart 

import STEP242 file to new part

Messages output when opening the file.

Enumerator
MessageEnumNone 

none

MessageEnumInformational 

informational

MessageEnumWarning 

warning

MessageEnumError 

error

MessageEnumDebug 

debug

MessageEnumAll 

all

Member Function Documentation

bool NXOpen::Step242Importer::FileOpenFlag ( )

Returns the file open flag - set this to false if doing file import
Created in NX11.0.0.



License requirements : None

bool NXOpen::Step242Importer::FlattenAssembly ( )

Returns the flatten assembly - if set to true then assembly structure will not be retained
Created in NX11.0.0.



License requirements : None

NXOpen::Step242Importer::ImportToOption NXOpen::Step242Importer::ImportTo ( )

Returns the import to - this option will determine the destination for imported iges file.

it can either be new part or work part.
Created in NX11.0.0.

License requirements : None

bool NXOpen::Step242Importer::ImportToTeamcenter ( )

Returns the ImportToTeamcenter command - if set to true then the assembly will be imported into Teamcenter
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Step242Importer::InputFile ( )

Returns the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

NXOpen::Step242Importer::MessageEnum NXOpen::Step242Importer::Messages ( )

Returns the message level for syslog messages when loading Step242 files
Created in NX11.0.0.



License requirements : None

NXOpen::ObjectTypeSelector* NXOpen::Step242Importer::ObjectTypes ( )

Returns the objectTypes - this is subcomponent being used to set object types filters.

This will be used to filter objects based on the types
Created in NX11.0.0.

License requirements : None

bool NXOpen::Step242Importer::Optimize ( )

Returns the optimize - if set to true Optimizes geometry
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Step242Importer::OutputFile ( )

Returns the output file - if iges file is imported to new part then this name will be used to write the output.


Created in NX11.0.0.

License requirements : None

void NXOpen::Step242Importer::SaveSettings ( const NXString filename)

Saves the save settings - this will save the settings to a file specified
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SaveSettings ( const char *  filename)

Saves the save settings - this will save the settings to a file specified
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetFileOpenFlag ( bool  doingFileOpen)

Sets the file open flag - set this to false if doing file import
Created in NX11.0.0.



License requirements : None

Parameters
doingFileOpendoingfileopen
void NXOpen::Step242Importer::SetFlattenAssembly ( bool  flattenAssembly)

Sets the flatten assembly - if set to true then assembly structure will not be retained
Created in NX11.0.0.



License requirements : None

Parameters
flattenAssemblyflattenassembly
void NXOpen::Step242Importer::SetImportTo ( NXOpen::Step242Importer::ImportToOption  importTo)

Sets the import to - this option will determine the destination for imported iges file.

it can either be new part or work part.
Created in NX11.0.0.

License requirements : None

Parameters
importToimportto
void NXOpen::Step242Importer::SetImportToTeamcenter ( bool  importToTeamcenter)

Sets the ImportToTeamcenter command - if set to true then the assembly will be imported into Teamcenter
Created in NX11.0.0.



License requirements : None

Parameters
importToTeamcenterimporttoteamcenter
void NXOpen::Step242Importer::SetInputFile ( const NXString filename)

Sets the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetInputFile ( const char *  filename)

Sets the input file - name of a file which is being imported
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetMessages ( NXOpen::Step242Importer::MessageEnum  messages)

Sets the message level for syslog messages when loading Step242 files
Created in NX11.0.0.



License requirements : None

Parameters
messagesmessages
void NXOpen::Step242Importer::SetOptimize ( bool  optimize)

Sets the optimize - if set to true Optimizes geometry
Created in NX11.0.0.



License requirements : None

Parameters
optimizeoptimize
void NXOpen::Step242Importer::SetOutputFile ( const NXString filename)

Sets the output file - if iges file is imported to new part then this name will be used to write the output.


Created in NX11.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetOutputFile ( const char *  filename)

Sets the output file - if iges file is imported to new part then this name will be used to write the output.


Created in NX11.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetSettingsFile ( const NXString filename)

Sets the settings file - definition file for default options
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetSettingsFile ( const char *  filename)

Sets the settings file - definition file for default options
Created in NX11.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Step242Importer::SetSewSurfaces ( bool  sewSurfaces)

Sets the sew surfaces - if set to true surfaces will be sewed automatically
Created in NX11.0.0.



License requirements : None

Parameters
sewSurfacessewsurfaces
void NXOpen::Step242Importer::SetSimplifyGeometry ( bool  simplifyGeometry)

Sets the simplify geometry - if set to true geometry will be simplified automatically
Created in NX11.0.0.



License requirements : None

Parameters
simplifyGeometrysimplifygeometry
void NXOpen::Step242Importer::SetSmoothBSurfaces ( bool  smoothBSurfaces)

Sets the Smooth B-Surfaces - if set to true smooth B-Surfaces
Created in NX11.0.0.



License requirements : None

Parameters
smoothBSurfacessmoothbsurfaces
NXString NXOpen::Step242Importer::SettingsFile ( )

Returns the settings file - definition file for default options
Created in NX11.0.0.



License requirements : None

bool NXOpen::Step242Importer::SewSurfaces ( )

Returns the sew surfaces - if set to true surfaces will be sewed automatically
Created in NX11.0.0.



License requirements : None

bool NXOpen::Step242Importer::SimplifyGeometry ( )

Returns the simplify geometry - if set to true geometry will be simplified automatically
Created in NX11.0.0.



License requirements : None

bool NXOpen::Step242Importer::SmoothBSurfaces ( )

Returns the Smooth B-Surfaces - if set to true smooth B-Surfaces
Created in NX11.0.0.



License requirements : None


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