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

Represents a Drawings::ConvertDraftingContentsBuilder . More...

Inheritance diagram for NXOpen::Drawings::ConvertDraftingContentsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SelectConversionEntityType { SelectConversionEntityTypeDrawing, SelectConversionEntityTypeSheet, SelectConversionEntityTypeView, SelectConversionEntityTypeAnnotation }
 enum is used to list out different entity that can be use for conversion More...
 

Public Member Functions

NXString ConfigurationFile ()
 Returns the configuration file
Created in NX11.0.0. More...
 
bool OpenConvertedPmiDestinationPart ()
 Returns the option to open converted pmi destination part
Created in NX12.0.0. More...
 
NXOpen::SelectViewListSelectDraftingSheet ()
 Returns the select drafting sheet block. More...
 
NXOpen::Drawings::SelectDraftingViewListSelectDraftingView ()
 Returns the select drafting view block
Created in NX11.0.0. More...
 
NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectConversionEntityType SelectionType ()
 Returns the selection type
Created in NX11.0.0. More...
 
NXOpen::SelectNXObjectListSelectObjectsToConvert ()
 Returns the select objects to convert
Created in NX11.0.0. More...
 
void SetConfigurationFile (const NXString &filename)
 Sets the configuration file
Created in NX11.0.0. More...
 
void SetConfigurationFile (const char *filename)
 Sets the configuration file
Created in NX11.0.0. More...
 
void SetContextAssembly (const NXString &contextAssembly)
 Context assembly part file path
Created in NX11.0.0. More...
 
void SetContextAssembly (const char *contextAssembly)
 Context assembly part file path
Created in NX11.0.0. More...
 
void SetOpenConvertedPmiDestinationPart (bool openConvertedPmiDestinationPart)
 Sets the option to open converted pmi destination part
Created in NX12.0.0. More...
 
void SetSelectionType (NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectConversionEntityType selectionType)
 Sets the selection type
Created in NX11.0.0. More...
 
NXOpen::Drawings::SettingsBuilderSettingsBuilder ()
 Returns the settings
Created in NX11.0.0. More...
 
void SetUseContextAssembly (bool useContextAssembly)
 Sets the use context assembly
Created in NX11.0.0. More...
 
bool UseContextAssembly ()
 Returns the use context assembly
Created in NX11.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 Drawings::ConvertDraftingContentsBuilder .

This class queries and sets settings specific to drafting data which will get converted to PMI.
To create a new instance of this class, use NXOpen::Drawings::ConvertToPMIBuilderManager::CreateConvertDraftingContentsBuilder
Default values.

Property Value

SelectionType

Drawing

UseContextAssembly

0


Created in NX11.0.0.

Member Enumeration Documentation

enum is used to list out different entity that can be use for conversion

Enumerator
SelectConversionEntityTypeDrawing 

drawing

SelectConversionEntityTypeSheet 

sheet

SelectConversionEntityTypeView 

view

SelectConversionEntityTypeAnnotation 

annotation

Member Function Documentation

NXString NXOpen::Drawings::ConvertDraftingContentsBuilder::ConfigurationFile ( )

Returns the configuration file
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ConvertDraftingContentsBuilder::OpenConvertedPmiDestinationPart ( )

Returns the option to open converted pmi destination part
Created in NX12.0.0.



License requirements : None

NXOpen::SelectViewList* NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectDraftingSheet ( )

Returns the select drafting sheet block.

Expect selection object of type DraftingSheet, validation is done at builder level
Created in NX11.0.0.

License requirements : None

NXOpen::Drawings::SelectDraftingViewList* NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectDraftingView ( )

Returns the select drafting view block
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectConversionEntityType NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectionType ( )

Returns the selection type
Created in NX11.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectObjectsToConvert ( )

Returns the select objects to convert
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetConfigurationFile ( const NXString filename)

Sets the configuration file
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

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

Sets the configuration file
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetContextAssembly ( const NXString contextAssembly)

Context assembly part file path
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
contextAssemblycontextassembly
void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetContextAssembly ( const char *  contextAssembly)

Context assembly part file path
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
contextAssemblycontextassembly
void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetOpenConvertedPmiDestinationPart ( bool  openConvertedPmiDestinationPart)

Sets the option to open converted pmi destination part
Created in NX12.0.0.



License requirements : drafting ("DRAFTING")

Parameters
openConvertedPmiDestinationPartopenconvertedpmidestinationpart
void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetSelectionType ( NXOpen::Drawings::ConvertDraftingContentsBuilder::SelectConversionEntityType  selectionType)

Sets the selection type
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
selectionTypeselectiontype
NXOpen::Drawings::SettingsBuilder* NXOpen::Drawings::ConvertDraftingContentsBuilder::SettingsBuilder ( )

Returns the settings
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::ConvertDraftingContentsBuilder::SetUseContextAssembly ( bool  useContextAssembly)

Sets the use context assembly
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
useContextAssemblyusecontextassembly
bool NXOpen::Drawings::ConvertDraftingContentsBuilder::UseContextAssembly ( )

Returns the use context assembly
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.