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

Represents a builder class that perofrms create operation
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateObjectCreateBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::PDM::ObjectCreateBuilder:
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 CreateLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Creates Pre-Creation LogicalObjects
Created in NX10.0.0. More...
 
NXString DefaultDestinationFolder ()
 Returns the default destination folder string for the object being created. More...
 
void GetAttributeHolderObjects (std::vector< NXOpen::PDM::GenericObjectAttributeHolder * > &attributeHolderObjects)
 Returns an array of AttributeHolderObjects created as part of commit. More...
 
void SetDefaultDestinationFolder (const NXString &defaultDestinationFolder)
 Sets the default destination folder string for the object being created. More...
 
void SetDefaultDestinationFolder (const char *defaultDestinationFolder)
 Sets the default destination folder string for the object being created. More...
 
void SetTypes (std::vector< NXString > &tcTypes, std::vector< NXString > &baseTCTypes)
 Set Types for which AttributeHolderObject needs to be created. 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 perofrms create operation
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateObjectCreateBuilder

Created in NX10.0.0.


Member Function Documentation

virtual NXOpen::ErrorList* NXOpen::PDM::ObjectCreateBuilder::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::ObjectCreateBuilder::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::ObjectCreateBuilder::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::PDM::ObjectCreateBuilder::CreateLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Creates Pre-Creation LogicalObjects
Created in NX10.0.0.



License requirements : None

Parameters
logicalObjectslogicalobjects
NXString NXOpen::PDM::ObjectCreateBuilder::DefaultDestinationFolder ( )

Returns the default destination folder string for the object being created.

The default destination folder string can be <username>:<folder>:<folder>, or :<folder>:<folder> means username is optional. In case of :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container.


Created in NX10.0.0.

License requirements : None

void NXOpen::PDM::ObjectCreateBuilder::GetAttributeHolderObjects ( std::vector< NXOpen::PDM::GenericObjectAttributeHolder * > &  attributeHolderObjects)

Returns an array of AttributeHolderObjects created as part of commit.


Created in NX10.0.0.

License requirements : None

Parameters
attributeHolderObjectsattributeholderobjects
void NXOpen::PDM::ObjectCreateBuilder::SetDefaultDestinationFolder ( const NXString defaultDestinationFolder)

Sets the default destination folder string for the object being created.

The default destination folder string can be <username>:<folder>:<folder>, or :<folder>:<folder> means username is optional. In case of :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container.


Created in NX10.0.0.

License requirements : None

Parameters
defaultDestinationFolderdefaultdestinationfolder
void NXOpen::PDM::ObjectCreateBuilder::SetDefaultDestinationFolder ( const char *  defaultDestinationFolder)

Sets the default destination folder string for the object being created.

The default destination folder string can be <username>:<folder>:<folder>, or :<folder>:<folder> means username is optional. In case of :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container.


Created in NX10.0.0.

License requirements : None

Parameters
defaultDestinationFolderdefaultdestinationfolder
void NXOpen::PDM::ObjectCreateBuilder::SetTypes ( std::vector< NXString > &  tcTypes,
std::vector< NXString > &  baseTCTypes 
)

Set Types for which AttributeHolderObject needs to be created.

This method will remove all previously set types.
Created in NX10.0.0.

License requirements : None

Parameters
tcTypestctypes
baseTCTypesbasetctypes

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