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

Represents a NXOpen::Step214Creator to be used when exporting the STEP214 Data This class is created using NXOpen::DexManager . More...

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

Public Types

enum  EntityNameOption { EntityNameOptionLongName, EntityNameOptionShortName }
 Entitiy Name Option. More...
 
enum  ExportFromOption { ExportFromOptionDisplayPart, ExportFromOptionExistingPart }
 Export From Option. More...
 
enum  ExternalReferenceOption { ExternalReferenceOptionStep, ExternalReferenceOptionNx }
 External Reference Option. More...
 

Public Member Functions

NXString Author ()
 Returns the author
Created in NX6.0.0. More...
 
NXString Authorization ()
 Returns the authorization
Created in NX6.0.0. More...
 
double BsplineTol ()
 Returns the bspline tolerance
Created in NX6.0.0. More...
 
NXString Company ()
 Returns the company
Created in NX6.0.0. More...
 
NXString Description ()
 Returns the description
Created in NX6.0.0. More...
 
NXOpen::Step214Creator::EntityNameOption EntityNames ()
 Returns the entity names types long or short
Created in NX6.0.0. More...
 
bool ExportExtRef ()
 Returns the export ext ref - if set to true NX data can be output as external reference
Created in NX6.0.0. More...
 
NXOpen::Step214Creator::ExternalReferenceOption ExportExtRefAs ()
 Returns the export ext ref as - specifiy the external reference type
Created in NX6.0.0. More...
 
NXOpen::Step214Creator::ExportFromOption ExportFrom ()
 Returns the export from - this option will determine if data from display part or existing part is exported
Created in NX6.0.0. More...
 
NXOpen::ObjectSelectorExportSelectionBlock ()
 Returns the export selection block - the object selection will be done by this block. More...
 
bool FileSaveFlag ()
 Returns the file save flag - set to false if doing file export
Created in NX6.0.0. More...
 
NXString InputFile ()
 Returns the input file - name of file which is being exported. More...
 
NXString LayerMask ()
 Returns the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information. More...
 
NXOpen::ObjectTypeSelectorObjectTypes ()
 Returns the objectTypes - this is subcomponent being used to set object types filters. More...
 
NXString OutputFile ()
 Returns the output file - the name of step file where output is being written
Created in NX6.0.0. More...
 
void SaveSettings (const NXString &filename)
 The save settings - this will save the settings to a file sepcified
Created in NX6.0.0. More...
 
void SaveSettings (const char *filename)
 The save settings - this will save the settings to a file sepcified
Created in NX6.0.0. More...
 
void SetAuthor (const NXString &author)
 Sets the author
Created in NX6.0.0. More...
 
void SetAuthor (const char *author)
 Sets the author
Created in NX6.0.0. More...
 
void SetAuthorization (const NXString &authorization)
 Sets the authorization
Created in NX6.0.0. More...
 
void SetAuthorization (const char *authorization)
 Sets the authorization
Created in NX6.0.0. More...
 
void SetBsplineTol (double bsplineTol)
 Sets the bspline tolerance
Created in NX6.0.0. More...
 
void SetCompany (const NXString &company)
 Sets the company
Created in NX6.0.0. More...
 
void SetCompany (const char *company)
 Sets the company
Created in NX6.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX6.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX6.0.0. More...
 
void SetEntityNames (NXOpen::Step214Creator::EntityNameOption entityNames)
 Sets the entity names types long or short
Created in NX6.0.0. More...
 
void SetExportExtRef (bool exportExtRef)
 Sets the export ext ref - if set to true NX data can be output as external reference
Created in NX6.0.0. More...
 
void SetExportExtRefAs (NXOpen::Step214Creator::ExternalReferenceOption exportExtRefAs)
 Sets the export ext ref as - specifiy the external reference type
Created in NX6.0.0. More...
 
void SetExportFrom (NXOpen::Step214Creator::ExportFromOption exportFrom)
 Sets the export from - this option will determine if data from display part or existing part is exported
Created in NX6.0.0. More...
 
void SetFileSaveFlag (bool doingFileSave)
 Sets the file save flag - set to false if doing file export
Created in NX6.0.0. More...
 
void SetInputFile (const NXString &filename)
 Sets the input file - name of file which is being exported. More...
 
void SetInputFile (const char *filename)
 Sets the input file - name of file which is being exported. More...
 
void SetLayerMask (const NXString &layerMask)
 Sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information. More...
 
void SetLayerMask (const char *layerMask)
 Sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information. More...
 
void SetOutputFile (const NXString &filename)
 Sets the output file - the name of step file where output is being written
Created in NX6.0.0. More...
 
void SetOutputFile (const char *filename)
 Sets the output file - the name of step file where output is being written
Created in NX6.0.0. More...
 
void SetSettingsFile (const NXString &filename)
 Sets the Settings File to read the default settings
Created in NX6.0.0. More...
 
void SetSettingsFile (const char *filename)
 Sets the Settings File to read the default settings
Created in NX6.0.0. More...
 
NXString SettingsFile ()
 Returns the Settings File to read the default settings
Created in NX6.0.0. More...
 
void SetValidationProperties (bool validationProperties)
 Sets the validation properties - if set to true validation properties will be created
Created in NX6.0.0. More...
 
bool ValidationProperties ()
 Returns the validation properties - if set to true validation properties will be created
Created in NX6.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::Step214Creator to be used when exporting the STEP214 Data This class is created using NXOpen::DexManager .

NULL object will be returned from Commit(). The workpart should be present in the session before calling commit().
To create a new instance of this class, use NXOpen::DexManager::CreateStep214Creator
Default values.

Property Value

BsplineTol

0.0254

EntityNames

LongName

ExportExtRef

0

ExportExtRefAs

Step

ExportFrom

DisplayPart

ProcessHoldFlag

0

ValidationProperties

0


Created in NX6.0.0.

Member Enumeration Documentation

Entitiy Name Option.

Enumerator
EntityNameOptionLongName 

create long names

EntityNameOptionShortName 

create short names

Export From Option.

Enumerator
ExportFromOptionDisplayPart 

export data from displayed part

ExportFromOptionExistingPart 

export data from existing part which is on disk

External Reference Option.

Enumerator
ExternalReferenceOptionStep 

output external reference as STEP file

ExternalReferenceOptionNx 

output external reference as NX file

Member Function Documentation

NXString NXOpen::Step214Creator::Author ( )

Returns the author
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Step214Creator::Authorization ( )

Returns the authorization
Created in NX6.0.0.



License requirements : None

double NXOpen::Step214Creator::BsplineTol ( )

Returns the bspline tolerance
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Step214Creator::Company ( )

Returns the company
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Step214Creator::Description ( )

Returns the description
Created in NX6.0.0.



License requirements : None

NXOpen::Step214Creator::EntityNameOption NXOpen::Step214Creator::EntityNames ( )

Returns the entity names types long or short
Created in NX6.0.0.



License requirements : None

bool NXOpen::Step214Creator::ExportExtRef ( )

Returns the export ext ref - if set to true NX data can be output as external reference
Created in NX6.0.0.



License requirements : None

NXOpen::Step214Creator::ExternalReferenceOption NXOpen::Step214Creator::ExportExtRefAs ( )

Returns the export ext ref as - specifiy the external reference type
Created in NX6.0.0.



License requirements : None

NXOpen::Step214Creator::ExportFromOption NXOpen::Step214Creator::ExportFrom ( )

Returns the export from - this option will determine if data from display part or existing part is exported
Created in NX6.0.0.



License requirements : None

NXOpen::ObjectSelector* NXOpen::Step214Creator::ExportSelectionBlock ( )

Returns the export selection block - the object selection will be done by this block.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Step214Creator::FileSaveFlag ( )

Returns the file save flag - set to false if doing file export
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Step214Creator::InputFile ( )

Returns the input file - name of file which is being exported.


Created in NX6.0.0.

License requirements : None

NXString NXOpen::Step214Creator::LayerMask ( )

Returns the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information.

You can enter layer numbers or layers ranges separated by commas. For example, 1, 5, 88-109,190-199, 201, 206-210 is a legal specification. The default setting for Layers to Export is 1-256.
Created in NX6.0.0.

License requirements : None

NXOpen::ObjectTypeSelector* NXOpen::Step214Creator::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 NX6.0.0.

License requirements : None

NXString NXOpen::Step214Creator::OutputFile ( )

Returns the output file - the name of step file where output is being written
Created in NX6.0.0.



License requirements : None

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

The save settings - this will save the settings to a file sepcified
Created in NX6.0.0.



License requirements : None

Parameters
filename
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Step214Creator::SaveSettings ( const char *  filename)

The save settings - this will save the settings to a file sepcified
Created in NX6.0.0.



License requirements : None

Parameters
filename
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Step214Creator::SetAuthor ( const NXString author)

Sets the author
Created in NX6.0.0.



License requirements : None

Parameters
authorauthor
void NXOpen::Step214Creator::SetAuthor ( const char *  author)

Sets the author
Created in NX6.0.0.



License requirements : None

Parameters
authorauthor
void NXOpen::Step214Creator::SetAuthorization ( const NXString authorization)

Sets the authorization
Created in NX6.0.0.



License requirements : None

Parameters
authorizationauthorization
void NXOpen::Step214Creator::SetAuthorization ( const char *  authorization)

Sets the authorization
Created in NX6.0.0.



License requirements : None

Parameters
authorizationauthorization
void NXOpen::Step214Creator::SetBsplineTol ( double  bsplineTol)

Sets the bspline tolerance
Created in NX6.0.0.



License requirements : None

Parameters
bsplineTolbsplinetol
void NXOpen::Step214Creator::SetCompany ( const NXString company)

Sets the company
Created in NX6.0.0.



License requirements : None

Parameters
companycompany
void NXOpen::Step214Creator::SetCompany ( const char *  company)

Sets the company
Created in NX6.0.0.



License requirements : None

Parameters
companycompany
void NXOpen::Step214Creator::SetDescription ( const NXString description)

Sets the description
Created in NX6.0.0.



License requirements : None

Parameters
descriptiondescription
void NXOpen::Step214Creator::SetDescription ( const char *  description)

Sets the description
Created in NX6.0.0.



License requirements : None

Parameters
descriptiondescription
void NXOpen::Step214Creator::SetEntityNames ( NXOpen::Step214Creator::EntityNameOption  entityNames)

Sets the entity names types long or short
Created in NX6.0.0.



License requirements : None

Parameters
entityNamesentitynames
void NXOpen::Step214Creator::SetExportExtRef ( bool  exportExtRef)

Sets the export ext ref - if set to true NX data can be output as external reference
Created in NX6.0.0.



License requirements : None

Parameters
exportExtRefexportextref
void NXOpen::Step214Creator::SetExportExtRefAs ( NXOpen::Step214Creator::ExternalReferenceOption  exportExtRefAs)

Sets the export ext ref as - specifiy the external reference type
Created in NX6.0.0.



License requirements : None

Parameters
exportExtRefAsexportextrefas
void NXOpen::Step214Creator::SetExportFrom ( NXOpen::Step214Creator::ExportFromOption  exportFrom)

Sets the export from - this option will determine if data from display part or existing part is exported
Created in NX6.0.0.



License requirements : None

Parameters
exportFromexportfrom
void NXOpen::Step214Creator::SetFileSaveFlag ( bool  doingFileSave)

Sets the file save flag - set to false if doing file export
Created in NX6.0.0.



License requirements : None

Parameters
doingFileSavedoingfilesave
void NXOpen::Step214Creator::SetInputFile ( const NXString filename)

Sets the input file - name of file which is being exported.


Created in NX6.0.0.

License requirements : None

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

Sets the input file - name of file which is being exported.


Created in NX6.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::Step214Creator::SetLayerMask ( const NXString layerMask)

Sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information.

You can enter layer numbers or layers ranges separated by commas. For example, 1, 5, 88-109,190-199, 201, 206-210 is a legal specification. The default setting for Layers to Export is 1-256.
Created in NX6.0.0.

License requirements : None

Parameters
layerMasklayermask
void NXOpen::Step214Creator::SetLayerMask ( const char *  layerMask)

Sets the layerMask - You can limit the data you export by only specifying the layers that contain the appropriate information.

You can enter layer numbers or layers ranges separated by commas. For example, 1, 5, 88-109,190-199, 201, 206-210 is a legal specification. The default setting for Layers to Export is 1-256.
Created in NX6.0.0.

License requirements : None

Parameters
layerMasklayermask
void NXOpen::Step214Creator::SetOutputFile ( const NXString filename)

Sets the output file - the name of step file where output is being written
Created in NX6.0.0.



License requirements : None

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

Sets the output file - the name of step file where output is being written
Created in NX6.0.0.



License requirements : None

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

Sets the Settings File to read the default settings
Created in NX6.0.0.



License requirements : None

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

Sets the Settings File to read the default settings
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
NXString NXOpen::Step214Creator::SettingsFile ( )

Returns the Settings File to read the default settings
Created in NX6.0.0.



License requirements : None

void NXOpen::Step214Creator::SetValidationProperties ( bool  validationProperties)

Sets the validation properties - if set to true validation properties will be created
Created in NX6.0.0.



License requirements : None

Parameters
validationPropertiesvalidationproperties
bool NXOpen::Step214Creator::ValidationProperties ( )

Returns the validation properties - if set to true validation properties will be created
Created in NX6.0.0.



License requirements : None


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