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

Represents a Builder for export component 2D hierarchy
To create a new instance of this class, use NXOpen::Layout2d::ComponentCollection::CreateExportComponentHierarchyBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::Layout2d::ExportComponentHierarchyBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool ChildComponentsForComponents ()
 Returns the flag indicating whether to export child components for components
Created in NX11.0.0. More...
 
bool ChildComponentsForDefinitions ()
 Returns the flag indicating whether to export child components for definitions
Created in NX11.0.0. More...
 
bool Contents ()
 Returns the flag indicating whether to export contents for components
Created in NX11.0.0. More...
 
bool DefinitionReferenceProperties ()
 Returns the flag indicating whether to export definition reference properties for components
Created in NX11.0.0. More...
 
bool Definitions ()
 Returns the flag indicating whether to export definitions for components
Created in NX11.0.0. More...
 
NXString OutputFileName ()
 Returns the selected output file
Created in NX11.0.0. More...
 
NXOpen::SelectDisplayableObjectListSelection ()
 Returns the selected objects which may be of NXOpen::Layout2d::Component or NXOpen::Sketch type
Created in NX11.0.0. More...
 
void SetChildComponentsForComponents (bool childComponentsForComponents)
 Sets the flag indicating whether to export child components for components
Created in NX11.0.0. More...
 
void SetChildComponentsForDefinitions (bool childComponentsForDefinitions)
 Sets the flag indicating whether to export child components for definitions
Created in NX11.0.0. More...
 
void SetContents (bool contents)
 Sets the flag indicating whether to export contents for components
Created in NX11.0.0. More...
 
void SetDefinitionReferenceProperties (bool definitionReferenceProperties)
 Sets the flag indicating whether to export definition reference properties for components
Created in NX11.0.0. More...
 
void SetDefinitions (bool definitions)
 Sets the flag indicating whether to export definitions for components
Created in NX11.0.0. More...
 
void SetOutputFileName (const NXString &outputFileName)
 Sets the selected output file
Created in NX11.0.0. More...
 
void SetOutputFileName (const char *outputFileName)
 Sets the selected output file
Created in NX11.0.0. More...
 
void SetSoftwareProperties (bool softwareProperties)
 Sets the flag indicating whether to export software properties for components
Created in NX11.0.0. More...
 
bool SoftwareProperties ()
 Returns the flag indicating whether to export software properties for components
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 Builder for export component 2D hierarchy
To create a new instance of this class, use NXOpen::Layout2d::ComponentCollection::CreateExportComponentHierarchyBuilder

Created in NX11.0.0.


Member Function Documentation

bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::ChildComponentsForComponents ( )

Returns the flag indicating whether to export child components for components
Created in NX11.0.0.



License requirements : None

bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::ChildComponentsForDefinitions ( )

Returns the flag indicating whether to export child components for definitions
Created in NX11.0.0.



License requirements : None

bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::Contents ( )

Returns the flag indicating whether to export contents for components
Created in NX11.0.0.



License requirements : None

bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::DefinitionReferenceProperties ( )

Returns the flag indicating whether to export definition reference properties for components
Created in NX11.0.0.



License requirements : None

bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::Definitions ( )

Returns the flag indicating whether to export definitions for components
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Layout2d::ExportComponentHierarchyBuilder::OutputFileName ( )

Returns the selected output file
Created in NX11.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Layout2d::ExportComponentHierarchyBuilder::Selection ( )

Returns the selected objects which may be of NXOpen::Layout2d::Component or NXOpen::Sketch type
Created in NX11.0.0.



License requirements : None

void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetChildComponentsForComponents ( bool  childComponentsForComponents)

Sets the flag indicating whether to export child components for components
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
childComponentsForComponentschildcomponentsforcomponents
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetChildComponentsForDefinitions ( bool  childComponentsForDefinitions)

Sets the flag indicating whether to export child components for definitions
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
childComponentsForDefinitionschildcomponentsfordefinitions
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetContents ( bool  contents)

Sets the flag indicating whether to export contents for components
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
contentscontents
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetDefinitionReferenceProperties ( bool  definitionReferenceProperties)

Sets the flag indicating whether to export definition reference properties for components
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
definitionReferencePropertiesdefinitionreferenceproperties
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetDefinitions ( bool  definitions)

Sets the flag indicating whether to export definitions for components
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
definitionsdefinitions
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetOutputFileName ( const NXString outputFileName)

Sets the selected output file
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
outputFileNameoutputfilename
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetOutputFileName ( const char *  outputFileName)

Sets the selected output file
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
outputFileNameoutputfilename
void NXOpen::Layout2d::ExportComponentHierarchyBuilder::SetSoftwareProperties ( bool  softwareProperties)

Sets the flag indicating whether to export software properties for components
Created in NX11.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
softwarePropertiessoftwareproperties
bool NXOpen::Layout2d::ExportComponentHierarchyBuilder::SoftwareProperties ( )

Returns the flag indicating whether to export software properties for components
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.