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

Represents a builder class that performs Create operations
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateExportWorksetForReferenceBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::PDM::ExportWorksetForReferenceBuilder:
NXOpen::Builder NXOpen::IAttributeSourceObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

virtual NXOpen::ErrorListAutoAssignAttributes (const std::vector< NXOpen::NXObject * > &objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::ErrorListAutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::NXObjectCreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern. More...
 
NXString DestinationFolder ()
 Returns the export directory path
Created in NX12.0.0. More...
 
void GetObjects (std::vector< NXOpen::NXObject * > &objects)
 Gets the objects for the modified objects in session. More...
 
void SetDestinationFolder (const NXString &folderPath)
 Sets the export directory path
Created in NX12.0.0. More...
 
void SetDestinationFolder (const char *folderPath)
 Sets the export directory path
Created in NX12.0.0. More...
 
NXOpen::ErrorListValidateObjects ()
 Validate the inputs provided for export. 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 class that performs Create operations
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateExportWorksetForReferenceBuilder

Created in NX10.0.0.


Member Function Documentation

virtual NXOpen::ErrorList* NXOpen::PDM::ExportWorksetForReferenceBuilder::AutoAssignAttributes ( const std::vector< NXOpen::NXObject * > &  objects)
virtual

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
objectsobjects

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::ErrorList* NXOpen::PDM::ExportWorksetForReferenceBuilder::AutoAssignAttributesWithNamingPattern ( const std::vector< NXOpen::NXObject * > &  objects,
const std::vector< NXOpen::NXObject * > &  properties 
)
virtual

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap

Returns

Created in NX12.0.0.

License requirements : None
Parameters
objectsobjects
propertiesproperties

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::NXObject* NXOpen::PDM::ExportWorksetForReferenceBuilder::CreateAttributeTitleToNamingPatternMap ( std::vector< NXString > &  attributeTitles,
std::vector< NXString > &  titlePatterns 
)
virtual

Creates a map object of attribute titles to their corresponding naming pattern.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
attributeTitlesattributetitles
titlePatternstitlepatterns

Implements NXOpen::IAttributeSourceObjectBuilder.

NXString NXOpen::PDM::ExportWorksetForReferenceBuilder::DestinationFolder ( )

Returns the export directory path
Created in NX12.0.0.



License requirements : None

void NXOpen::PDM::ExportWorksetForReferenceBuilder::GetObjects ( std::vector< NXOpen::NXObject * > &  objects)

Gets the objects for the modified objects in session.


Created in NX11.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::PDM::ExportWorksetForReferenceBuilder::SetDestinationFolder ( const NXString folderPath)

Sets the export directory path
Created in NX12.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
folderPathfolderpath
void NXOpen::PDM::ExportWorksetForReferenceBuilder::SetDestinationFolder ( const char *  folderPath)

Sets the export directory path
Created in NX12.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
folderPathfolderpath
NXOpen::ErrorList* NXOpen::PDM::ExportWorksetForReferenceBuilder::ValidateObjects ( )

Validate the inputs provided for export.

Returns

Created in NX12.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.