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

Represents a Drawings::ConversionProcessSettingsBuilder . More...

Inheritance diagram for NXOpen::Drawings::ConversionProcessSettingsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ActionOnErrorEnum { ActionOnErrorEnumSkipObjectAndContinue, ActionOnErrorEnumStopProcessingAfterLimit, ActionOnErrorEnumStopProcessing }
 enum is used to list out different Action on error types More...
 

Public Member Functions

NXOpen::Drawings::ConversionProcessSettingsBuilder::ActionOnErrorEnum ActionOnError ()
 Returns the action on error
Created in NX11.0.0. More...
 
NXString ConfigurationFile ()
 Returns the configuration file browser
Created in NX11.0.0. More...
 
bool CreateInMasterModelPart ()
 Returns the create in master model part option
Created in NX12.0.0. More...
 
int ErrorLimit ()
 Returns the error limit integer
Created in NX11.0.0. More...
 
double JTGeometryTolerance ()
 Returns the geometry tolerance
Created in NX11.0.0. More...
 
NXString JTPartNameAttribute ()
 Returns the JT part name
Created in NX11.0.0. More...
 
NXString LogFileLocation ()
 Returns the log file location folder
Created in NX11.0.0. More...
 
bool MultiCADAssembly ()
 Returns the multi-CAD assembly
Created in NX11.0.0. More...
 
NXString SaveAsLocation ()
 Returns the save as file browser
Created in NX11.0.0. More...
 
void SetActionOnError (NXOpen::Drawings::ConversionProcessSettingsBuilder::ActionOnErrorEnum actionOnError)
 Sets the action on error
Created in NX11.0.0. More...
 
void SetConfigurationFile (const NXString &filename)
 Sets the configuration file browser
Created in NX11.0.0. More...
 
void SetConfigurationFile (const char *filename)
 Sets the configuration file browser
Created in NX11.0.0. More...
 
void SetCreateInMasterModelPart (bool createInMasterModelPart)
 Sets the create in master model part option
Created in NX12.0.0. More...
 
void SetErrorLimit (int errorLimit)
 Sets the error limit integer
Created in NX11.0.0. More...
 
void SetJTGeometryTolerance (double geometryTolerance)
 Sets the geometry tolerance
Created in NX11.0.0. More...
 
void SetJTPartNameAttribute (const NXString &partNameAttribute)
 Sets the JT part name
Created in NX11.0.0. More...
 
void SetJTPartNameAttribute (const char *partNameAttribute)
 Sets the JT part name
Created in NX11.0.0. More...
 
void SetLogFileLocation (const NXString &foldername)
 Sets the log file location folder
Created in NX11.0.0. More...
 
void SetLogFileLocation (const char *foldername)
 Sets the log file location folder
Created in NX11.0.0. More...
 
void SetMultiCADAssembly (bool multiCADAssembly)
 Sets the multi-CAD assembly
Created in NX11.0.0. More...
 
void SetSaveAsLocation (const NXString &filename)
 Sets the save as file browser
Created in NX11.0.0. More...
 
void SetSaveAsLocation (const char *filename)
 Sets the save as file browser
Created in NX11.0.0. More...
 
void SetSourcePartNameAttribute (const NXString &partNameAttribute)
 Sets the Source part name
Created in NX11.0.0. More...
 
void SetSourcePartNameAttribute (const char *partNameAttribute)
 Sets the Source part name
Created in NX11.0.0. More...
 
void SetStoreLogFileInTeamCenter (bool storeLogFileInTeamCenter)
 Sets the store log file in teamcenter
Created in NX11.0.0. More...
 
NXString SourcePartNameAttribute ()
 Returns the Source part name
Created in NX11.0.0. More...
 
bool StoreLogFileInTeamCenter ()
 Returns the store log file in teamcenter
Created in NX11.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 Drawings::ConversionProcessSettingsBuilder .

This class queries and sets settings specific to drafting data which will get converted to PMIs.


Created in NX11.0.0.

Member Enumeration Documentation

enum is used to list out different Action on error types

Enumerator
ActionOnErrorEnumSkipObjectAndContinue 

skip object and continue

ActionOnErrorEnumStopProcessingAfterLimit 

stop processing after limit

ActionOnErrorEnumStopProcessing 

stop processing

Member Function Documentation

NXOpen::Drawings::ConversionProcessSettingsBuilder::ActionOnErrorEnum NXOpen::Drawings::ConversionProcessSettingsBuilder::ActionOnError ( )

Returns the action on error
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ConversionProcessSettingsBuilder::ConfigurationFile ( )

Returns the configuration file browser
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ConversionProcessSettingsBuilder::CreateInMasterModelPart ( )

Returns the create in master model part option
Created in NX12.0.0.



License requirements : None

int NXOpen::Drawings::ConversionProcessSettingsBuilder::ErrorLimit ( )

Returns the error limit integer
Created in NX11.0.0.



License requirements : None

double NXOpen::Drawings::ConversionProcessSettingsBuilder::JTGeometryTolerance ( )

Returns the geometry tolerance
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ConversionProcessSettingsBuilder::JTPartNameAttribute ( )

Returns the JT part name
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ConversionProcessSettingsBuilder::LogFileLocation ( )

Returns the log file location folder
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ConversionProcessSettingsBuilder::MultiCADAssembly ( )

Returns the multi-CAD assembly
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ConversionProcessSettingsBuilder::SaveAsLocation ( )

Returns the save as file browser
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetActionOnError ( NXOpen::Drawings::ConversionProcessSettingsBuilder::ActionOnErrorEnum  actionOnError)

Sets the action on error
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
actionOnErroractiononerror
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetConfigurationFile ( const NXString filename)

Sets the configuration file browser
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetConfigurationFile ( const char *  filename)

Sets the configuration file browser
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetCreateInMasterModelPart ( bool  createInMasterModelPart)

Sets the create in master model part option
Created in NX12.0.0.



License requirements : drafting ("DRAFTING")

Parameters
createInMasterModelPartcreateinmastermodelpart
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetErrorLimit ( int  errorLimit)

Sets the error limit integer
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
errorLimiterrorlimit
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetJTGeometryTolerance ( double  geometryTolerance)

Sets the geometry tolerance
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
geometryTolerancegeometrytolerance
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetJTPartNameAttribute ( const NXString partNameAttribute)

Sets the JT part name
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNameAttributepartnameattribute
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetJTPartNameAttribute ( const char *  partNameAttribute)

Sets the JT part name
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNameAttributepartnameattribute
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetLogFileLocation ( const NXString foldername)

Sets the log file location folder
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foldernamefoldername
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetLogFileLocation ( const char *  foldername)

Sets the log file location folder
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foldernamefoldername
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetMultiCADAssembly ( bool  multiCADAssembly)

Sets the multi-CAD assembly
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
multiCADAssemblymulticadassembly
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetSaveAsLocation ( const NXString filename)

Sets the save as file browser
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetSaveAsLocation ( const char *  filename)

Sets the save as file browser
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetSourcePartNameAttribute ( const NXString partNameAttribute)

Sets the Source part name
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNameAttributepartnameattribute
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetSourcePartNameAttribute ( const char *  partNameAttribute)

Sets the Source part name
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNameAttributepartnameattribute
void NXOpen::Drawings::ConversionProcessSettingsBuilder::SetStoreLogFileInTeamCenter ( bool  storeLogFileInTeamCenter)

Sets the store log file in teamcenter
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
storeLogFileInTeamCenterstorelogfileinteamcenter
NXString NXOpen::Drawings::ConversionProcessSettingsBuilder::SourcePartNameAttribute ( )

Returns the Source part name
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ConversionProcessSettingsBuilder::StoreLogFileInTeamCenter ( )

Returns the store log file in teamcenter
Created in NX11.0.0.



License requirements : None

virtual bool NXOpen::Drawings::ConversionProcessSettingsBuilder::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.