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

Represents a builder class that performs copying design element operation in 4GD. More...

Inheritance diagram for NXOpen::Assemblies::CopyDesignElementBuilder:
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...
 
void CreateDesignElementLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Creates the pre-creation objects for the design elements to be copied
Created in NX12.0.0. More...
 
void DeleteCopiedComponents ()
 Removes the copied components created during the copy operation
Created in NX12.0.0. More...
 
NXOpen::SelectDisplayableObjectListDesignElementsToCopy ()
 Returns the design elements to copy
Created in NX12.0.0. More...
 
void GetLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Returns the pre-creation objects
Created in NX12.0.0. More...
 
void GetLogicalObjectsHavingUnassignedRequiredAttributes (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Returns the pre-creation objects which have unassign required attributes
Created in NX12.0.0. More...
 
NXOpen::ErrorListGetOperationFailures ()
 Returns the design element copy operation failures. More...
 
void PartiallyCommit ()
 Copy design elements with minimal required information.Call to builder Commit is required after this to Commit creation. 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 copying design element operation in 4GD.


To create a new instance of this class, use NXOpen::CollaborativeContentManager::CreateCopyDesignElementBuilder

Created in NX12.0.0.

Member Function Documentation

virtual NXOpen::ErrorList* NXOpen::Assemblies::CopyDesignElementBuilder::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::Assemblies::CopyDesignElementBuilder::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::Assemblies::CopyDesignElementBuilder::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.

void NXOpen::Assemblies::CopyDesignElementBuilder::CreateDesignElementLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Creates the pre-creation objects for the design elements to be copied
Created in NX12.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
logicalObjectslogicalobjects
void NXOpen::Assemblies::CopyDesignElementBuilder::DeleteCopiedComponents ( )

Removes the copied components created during the copy operation
Created in NX12.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::CopyDesignElementBuilder::DesignElementsToCopy ( )

Returns the design elements to copy
Created in NX12.0.0.



License requirements : None

void NXOpen::Assemblies::CopyDesignElementBuilder::GetLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Returns the pre-creation objects
Created in NX12.0.0.



License requirements : None

Parameters
logicalObjectslogicalobjects
void NXOpen::Assemblies::CopyDesignElementBuilder::GetLogicalObjectsHavingUnassignedRequiredAttributes ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Returns the pre-creation objects which have unassign required attributes
Created in NX12.0.0.



License requirements : None

Parameters
logicalObjectslogicalobjects
NXOpen::ErrorList* NXOpen::Assemblies::CopyDesignElementBuilder::GetOperationFailures ( )

Returns the design element copy operation failures.

Returns

Created in NX12.0.0.

License requirements : None
void NXOpen::Assemblies::CopyDesignElementBuilder::PartiallyCommit ( )

Copy design elements with minimal required information.Call to builder Commit is required after this to Commit creation.


Created in NX12.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")


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