Represents a builder class that performs various design element operations. More...

Inheritance diagram for NXOpen::Assemblies::DesignElementBuilder:

Public Types
enum	EditActionType { EditActionTypeCategory, EditActionTypePartitions, EditActionTypeEffectivity }
	Represents the edit action on a design element. More...

enum	LayerOptionType { LayerOptionTypeOriginal, LayerOptionTypeWork, LayerOptionTypeAsSpecified }
	Represents the layer option of a design element. More...

enum	OperationType { OperationTypeCreate, OperationTypeEdit, OperationTypeSaveAs, OperationTypeSave, OperationTypeSaveAndClose, OperationTypeUndefined }
	Represents an operation type that can be performed on a design element. More...

enum	PositioningOption { PositioningOptionAbsoluteOrigin, PositioningOptionMaintain, PositioningOptionAsSpecified }
	Represents the positioning option of a design element. More...

enum	ReferenceSetType { ReferenceSetTypeModel, ReferenceSetTypeEntirePart, ReferenceSetTypeAsSpecified }
	Represents the reference set of a design element. More...

enum	SaveAsActionType { SaveAsActionTypeNewRevision, SaveAsActionTypeNewDesignElement }
	Represents the save as action on a design element. More...

enum	StateType { StateTypeShape, StateTypeReuse, StateTypePromissory }
	Represents the state of a design element. More...

Public Member Functions
void	AddToPartitions (const std::vector< NXOpen::Assemblies::Partition * > &partitions)
	Specify partitions to which the design elements will be added.

virtual NXOpen::ErrorList *	AutoAssignAttributes (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.

int	Count ()
	Returns the number of design elements to be created.

void	CreateLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
	Creates the pre-creation objects for the design elements Created in NX8.5.0.

NXOpen::SelectDisplayableObjectList *	DesignElementsToOperate ()
	Returns the design elements to operate upon Created in NX8.5.0.

NXString	DesignElementType ()
	Returns the type of a design element Created in NX9.0.0.

NXOpen::Assemblies::DesignElementBuilder::EditActionType	EditAction ()
	Returns the edit action type on a design element Created in NX8.5.0.

NXOpen::BasicEffectivityBuilder *	Effectivity ()
	Returns the effectivity interface of a design element

NXOpen::PDM::EffectivityTableBuilder *	EffectivityTable ()
	Returns the effectivity interface of a design element Created in NX9.0.0.

NXOpen::FileNew *	FileNewDescriptor ()
	Returns the file new descriptor to identify a design element Created in NX8.5.0.

void	GetAddPartitions (std::vector< NXOpen::Assemblies::Partition * > &partitions)
	Get the partitions to which the design elements will be added.

NXOpen::ErrorList *	GetOperationFailures ()
	Returns design element operation failures.

void	GetPosition (NXOpen::Point3d position, NXOpen::Matrix3x3 orientation)
	Gets the position of design element Created in NX8.5.0.

void	GetRemovePartitions (std::vector< NXOpen::Assemblies::Partition * > &partitions)
	Get the partitions from which the design elements will be removed.

bool	KeepOriginalDesignElement ()
	Returns the option determines whether to keep the original design element in the subset during save as.

int	Layer ()
	Returns the layer value of a design element.

NXOpen::Assemblies::DesignElementBuilder::LayerOptionType	LayerOption ()
	Returns the layer option of a design element Created in NX8.5.0.

NXOpen::Assemblies::Subset *	OwningSubsetInstance ()
	Returns the owning subset instance Created in NX8.5.0.

NXOpen::BasePart *	PartToUse ()
	Returns the part to use of a reuse design element.

NXOpen::Assemblies::DesignElementBuilder::PositioningOption	PositioningOptionValue ()
	Returns the positioning option of a design element Created in NX9.0.0.

NXOpen::Assemblies::DesignElementBuilder::ReferenceSetType	ReferenceSet ()
	Returns the reference set of a design element Created in NX8.5.0.

NXString	ReferenceSetName ()
	Returns the reference set name of a design element.

void	RemoveFromPartitions (const std::vector< NXOpen::Assemblies::Partition * > &partitions)
	Specify partitions from which the design elements will be removed.

NXOpen::Assemblies::DesignElementBuilder::SaveAsActionType	SaveAsAction ()
	Returns the save as action type of a design element Created in NX8.5.0.

bool	Scatter ()
	Returns the option to determine whether to scatter design elements during creation Created in NX9.0.0.

void	SetCount (int count)
	Sets the number of design elements to be created.

void	SetDesignElementType (const NXString &deType)
	Sets the type of a design element Created in NX9.0.0.

void	SetDesignElementType (const char *deType)
	Sets the type of a design element Created in NX9.0.0.

void	SetEditAction (NXOpen::Assemblies::DesignElementBuilder::EditActionType actionType)
	Sets the edit action type on a design element Created in NX8.5.0.

void	SetKeepOriginalDesignElement (bool valueType)
	Sets the option determines whether to keep the original design element in the subset during save as.

void	SetLayer (int layer)
	Sets the layer value of a design element.

void	SetLayerOption (NXOpen::Assemblies::DesignElementBuilder::LayerOptionType layerOption)
	Sets the layer option of a design element Created in NX8.5.0.

void	SetOwningSubsetInstance (NXOpen::Assemblies::Subset *subsetInstance)
	Sets the owning subset instance Created in NX8.5.0.

void	SetPartToUse (NXOpen::BasePart *partToUse)
	Sets the part to use of a reuse design element.

void	SetPosition (const NXOpen::Point3d &position, const NXOpen::Matrix3x3 &orientation)
	Sets the position of design element.

void	SetPositioningOptionValue (NXOpen::Assemblies::DesignElementBuilder::PositioningOption positioningOption)
	Sets the positioning option of a design element Created in NX9.0.0.

void	SetReferenceSet (NXOpen::Assemblies::DesignElementBuilder::ReferenceSetType referenceSet)
	Sets the reference set of a design element Created in NX8.5.0.

void	SetReferenceSetName (const NXString &referenceSetName)
	Sets the reference set name of a design element.

void	SetReferenceSetName (const char *referenceSetName)
	Sets the reference set name of a design element.

void	SetSaveAsAction (NXOpen::Assemblies::DesignElementBuilder::SaveAsActionType actionType)
	Sets the save as action type of a design element Created in NX8.5.0.

void	SetScatter (bool scatterValue)
	Sets the option to determine whether to scatter design elements during creation Created in NX9.0.0.

void	SetState (NXOpen::Assemblies::DesignElementBuilder::StateType state)
	Sets the state of a design element Created in NX8.5.0.

NXOpen::Assemblies::DesignElementBuilder::StateType	State ()
	Returns the state of a design element Created in NX8.5.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a builder class that performs various design element operations.

    The operation can be one of @link Assemblies::DesignElementBuilder::OperationType Assemblies::DesignElementBuilder::OperationType@endlink   <br> To create a new instance of this class, use @link CollaborativeContentManager::CreateDesignElementBuilder  CollaborativeContentManager::CreateDesignElementBuilder @endlink  <br>

Default values.

Property

Value

EditAction

Partitions

KeepOriginalDesignElement

0

LayerOption

Original

PositioningOptionValue

Maintain

ReferenceSet

EntirePart

SaveAsAction

NewRevision

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::DesignElementBuilder::EditActionType

Represents the edit action on a design element.

Enumerator:

EditActionTypeCategory	category
EditActionTypePartitions	partitions
EditActionTypeEffectivity	effectivity

enum NXOpen::Assemblies::DesignElementBuilder::LayerOptionType

Represents the layer option of a design element.

Enumerator:

LayerOptionTypeOriginal	Original layer.
LayerOptionTypeWork	Work layer.
LayerOptionTypeAsSpecified	As specified layer.

enum NXOpen::Assemblies::DesignElementBuilder::OperationType

Represents an operation type that can be performed on a design element.

Enumerator:

OperationTypeCreate	Creates a design element.
OperationTypeEdit	Edits a design element.
OperationTypeSaveAs	Save as a design element.
OperationTypeSave	Saves a design element.
OperationTypeSaveAndClose	Saves a design element and if it is a reuse closes the reused part.
OperationTypeUndefined	undefined

enum NXOpen::Assemblies::DesignElementBuilder::PositioningOption

Represents the positioning option of a design element.

Enumerator:

PositioningOptionAbsoluteOrigin

Applies absolute origin position on the design elements.

PositioningOptionMaintain

Maintains the existing positions of the design elements.

Applicable only if the edit action type is set to DesignElementBuilder::EditActionTypeCategory

PositioningOptionAsSpecified

Applies the specified position on the design elements.

enum NXOpen::Assemblies::DesignElementBuilder::ReferenceSetType

Represents the reference set of a design element.

Enumerator:

ReferenceSetTypeModel	Model.
ReferenceSetTypeEntirePart	Entire part.
ReferenceSetTypeAsSpecified	As specified reference set.

enum NXOpen::Assemblies::DesignElementBuilder::SaveAsActionType

Represents the save as action on a design element.

Enumerator:

SaveAsActionTypeNewRevision	new revision
SaveAsActionTypeNewDesignElement	new design element

enum NXOpen::Assemblies::DesignElementBuilder::StateType

Represents the state of a design element.

Enumerator:

StateTypeShape	Shape design element.
StateTypeReuse	Reuse design element.
StateTypePromissory	Promissory design element.

Member Function Documentation

void NXOpen::Assemblies::DesignElementBuilder::AddToPartitions ( const std::vector< NXOpen::Assemblies::Partition * > & partitions )

Specify partitions to which the design elements will be added.

The design elements will remain a member of any partitions to which they already belongs. The partitions to which the design elements will be added accumulate if this method is called more than once. If both Assemblies::DesignElementBuilder::AddToPartitions and Assemblies::DesignElementBuilder::RemoveFromPartitions are called with the same partition then the design elements will be added or removed from that partition depending upon which was the last method called.

Created in NX8.5.0.

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

Parameters

partitions partitions

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

objects objects

Implements NXOpen::IAttributeSourceObjectBuilder.

int NXOpen::Assemblies::DesignElementBuilder::Count ( )

Returns the number of design elements to be created.

Applicable only if the operation type is set to DesignElementBuilder::OperationTypeCreate
Created in NX8.5.0.

License requirements : None

void NXOpen::Assemblies::DesignElementBuilder::CreateLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > & logicalObjects )

Creates the pre-creation objects for the design elements
Created in NX8.5.0.

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

Parameters

logicalObjects logicalobjects

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::DesignElementBuilder::DesignElementsToOperate ( )

Returns the design elements to operate upon
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Assemblies::DesignElementBuilder::DesignElementType ( )

Returns the type of a design element
Created in NX9.0.0.

License requirements : None

NXOpen::Assemblies::DesignElementBuilder::EditActionType NXOpen::Assemblies::DesignElementBuilder::EditAction ( )

Returns the edit action type on a design element
Created in NX8.5.0.

License requirements : None

NXOpen::BasicEffectivityBuilder* NXOpen::Assemblies::DesignElementBuilder::Effectivity ( )

Returns the effectivity interface of a design element

Deprecated:: Deprecated in NX9.0.0.

Use NXOpen::Assemblies::DesignElementBuilder::EffectivityTable instead.

Created in NX8.5.0.

License requirements : None

NXOpen::PDM::EffectivityTableBuilder* NXOpen::Assemblies::DesignElementBuilder::EffectivityTable ( )

Returns the effectivity interface of a design element
Created in NX9.0.0.

License requirements : None

NXOpen::FileNew* NXOpen::Assemblies::DesignElementBuilder::FileNewDescriptor ( )

Returns the file new descriptor to identify a design element
Created in NX8.5.0.

License requirements : None

void NXOpen::Assemblies::DesignElementBuilder::GetAddPartitions ( std::vector< NXOpen::Assemblies::Partition * > & partitions )

Get the partitions to which the design elements will be added.

Created in NX8.5.0.

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

Parameters

partitions partitions

NXOpen::ErrorList* NXOpen::Assemblies::DesignElementBuilder::GetOperationFailures ( )

Returns design element operation failures.

Returns: Created in NX8.5.0.

License requirements : None

void NXOpen::Assemblies::DesignElementBuilder::GetPosition	(	NXOpen::Point3d *	position,
		NXOpen::Matrix3x3 *	orientation
	)

Gets the position of design element
Created in NX8.5.0.

License requirements : None

Parameters

position	position
orientation	orientation

void NXOpen::Assemblies::DesignElementBuilder::GetRemovePartitions ( std::vector< NXOpen::Assemblies::Partition * > & partitions )

Get the partitions from which the design elements will be removed.

Created in NX8.5.0.

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

Parameters

partitions partitions

bool NXOpen::Assemblies::DesignElementBuilder::KeepOriginalDesignElement ( )

Returns the option determines whether to keep the original design element in the subset during save as.

Created in NX8.5.0.

License requirements : None

int NXOpen::Assemblies::DesignElementBuilder::Layer ( )

Returns the layer value of a design element.

Applicable only if the layer option is set to DesignElementBuilder::LayerOptionTypeAsSpecified

Created in NX8.5.0.

License requirements : None

NXOpen::Assemblies::DesignElementBuilder::LayerOptionType NXOpen::Assemblies::DesignElementBuilder::LayerOption ( )

Returns the layer option of a design element
Created in NX8.5.0.

License requirements : None

NXOpen::Assemblies::Subset* NXOpen::Assemblies::DesignElementBuilder::OwningSubsetInstance ( )

Returns the owning subset instance
Created in NX8.5.0.

License requirements : None

NXOpen::BasePart* NXOpen::Assemblies::DesignElementBuilder::PartToUse ( )

Returns the part to use of a reuse design element.

Applicable only if the state is set to DesignElementBuilder::StateTypeReuse

Created in NX8.5.0.

License requirements : None

NXOpen::Assemblies::DesignElementBuilder::PositioningOption NXOpen::Assemblies::DesignElementBuilder::PositioningOptionValue ( )

Returns the positioning option of a design element
Created in NX9.0.0.

License requirements : None

NXOpen::Assemblies::DesignElementBuilder::ReferenceSetType NXOpen::Assemblies::DesignElementBuilder::ReferenceSet ( )

Returns the reference set of a design element
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Assemblies::DesignElementBuilder::ReferenceSetName ( )

Returns the reference set name of a design element.

Applicable only if the reference set is set to DesignElementBuilder::ReferenceSetTypeAsSpecified

Created in NX8.5.0.

License requirements : None

void NXOpen::Assemblies::DesignElementBuilder::RemoveFromPartitions ( const std::vector< NXOpen::Assemblies::Partition * > & partitions )

Specify partitions from which the design elements will be removed.

The partitions from which the design elements will be removed accumulate if this method is called more than once. If both Assemblies::DesignElementBuilder::AddToPartitions and Assemblies::DesignElementBuilder::RemoveFromPartitions are called with the same partition then the design elements will be added or removed from that partition depending upon which was the last method called.

Created in NX8.5.0.

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

Parameters

partitions partitions

NXOpen::Assemblies::DesignElementBuilder::SaveAsActionType NXOpen::Assemblies::DesignElementBuilder::SaveAsAction ( )

Returns the save as action type of a design element
Created in NX8.5.0.

License requirements : None

bool NXOpen::Assemblies::DesignElementBuilder::Scatter ( )

Returns the option to determine whether to scatter design elements during creation
Created in NX9.0.0.

License requirements : None

void NXOpen::Assemblies::DesignElementBuilder::SetCount ( int count )

Sets the number of design elements to be created.

Applicable only if the operation type is set to DesignElementBuilder::OperationTypeCreate
Created in NX8.5.0.

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

Parameters

count count

void NXOpen::Assemblies::DesignElementBuilder::SetDesignElementType ( const NXString & deType )

Sets the type of a design element
Created in NX9.0.0.

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

Parameters

deType detype

void NXOpen::Assemblies::DesignElementBuilder::SetDesignElementType ( const char * deType )

Sets the type of a design element
Created in NX9.0.0.

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

Parameters

deType detype

void NXOpen::Assemblies::DesignElementBuilder::SetEditAction ( NXOpen::Assemblies::DesignElementBuilder::EditActionType actionType )

Sets the edit action type on a design element
Created in NX8.5.0.

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

Parameters

actionType actiontype

void NXOpen::Assemblies::DesignElementBuilder::SetKeepOriginalDesignElement ( bool valueType )

Sets the option determines whether to keep the original design element in the subset during save as.

Created in NX8.5.0.

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

Parameters

valueType valuetype

void NXOpen::Assemblies::DesignElementBuilder::SetLayer ( int layer )

Sets the layer value of a design element.

Applicable only if the layer option is set to DesignElementBuilder::LayerOptionTypeAsSpecified

Created in NX8.5.0.

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

Parameters

layer layer

void NXOpen::Assemblies::DesignElementBuilder::SetLayerOption ( NXOpen::Assemblies::DesignElementBuilder::LayerOptionType layerOption )

Sets the layer option of a design element
Created in NX8.5.0.

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

Parameters

layerOption layeroption

void NXOpen::Assemblies::DesignElementBuilder::SetOwningSubsetInstance ( NXOpen::Assemblies::Subset * subsetInstance )

Sets the owning subset instance
Created in NX8.5.0.

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

Parameters

subsetInstance subsetinstance

void NXOpen::Assemblies::DesignElementBuilder::SetPartToUse ( NXOpen::BasePart * partToUse )

Sets the part to use of a reuse design element.

Applicable only if the state is set to DesignElementBuilder::StateTypeReuse

Created in NX8.5.0.

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

Parameters

partToUse parttouse

void NXOpen::Assemblies::DesignElementBuilder::SetPosition	(	const NXOpen::Point3d &	position,
		const NXOpen::Matrix3x3 &	orientation
	)

Sets the position of design element.

This value is used only when positioning option is DesignElementBuilder::PositioningOptionAsSpecified
Created in NX8.5.0.

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

Parameters

position	position
orientation	orientation

void NXOpen::Assemblies::DesignElementBuilder::SetPositioningOptionValue ( NXOpen::Assemblies::DesignElementBuilder::PositioningOption positioningOption )

Sets the positioning option of a design element
Created in NX9.0.0.

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

Parameters

positioningOption positioningoption

void NXOpen::Assemblies::DesignElementBuilder::SetReferenceSet ( NXOpen::Assemblies::DesignElementBuilder::ReferenceSetType referenceSet )

Sets the reference set of a design element
Created in NX8.5.0.

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

Parameters

referenceSet referenceset

void NXOpen::Assemblies::DesignElementBuilder::SetReferenceSetName ( const NXString & referenceSetName )

Sets the reference set name of a design element.

Applicable only if the reference set is set to DesignElementBuilder::ReferenceSetTypeAsSpecified

Created in NX8.5.0.

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

Parameters

referenceSetName referencesetname

void NXOpen::Assemblies::DesignElementBuilder::SetReferenceSetName ( const char * referenceSetName )

Sets the reference set name of a design element.

Applicable only if the reference set is set to DesignElementBuilder::ReferenceSetTypeAsSpecified

Created in NX8.5.0.

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

Parameters

referenceSetName referencesetname

void NXOpen::Assemblies::DesignElementBuilder::SetSaveAsAction ( NXOpen::Assemblies::DesignElementBuilder::SaveAsActionType actionType )

Sets the save as action type of a design element
Created in NX8.5.0.

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

Parameters

actionType actiontype

void NXOpen::Assemblies::DesignElementBuilder::SetScatter ( bool scatterValue )

Sets the option to determine whether to scatter design elements during creation
Created in NX9.0.0.

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

Parameters

scatterValue scattervalue

void NXOpen::Assemblies::DesignElementBuilder::SetState ( NXOpen::Assemblies::DesignElementBuilder::StateType state )

Sets the state of a design element
Created in NX8.5.0.

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

Parameters

state state

NXOpen::Assemblies::DesignElementBuilder::StateType NXOpen::Assemblies::DesignElementBuilder::State ( )

Returns the state of a design element
Created in NX8.5.0.

License requirements : None

The documentation for this class was generated from the following file:

Assemblies_DesignElementBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation