Represents a builder class that performs add submechanism in current context. More...

Inheritance diagram for NXOpen::Motion::AddSubmechanismBuilder:

Public Types
enum	Layer { LayerOriginal, LayerWork, LayerSpecified }
	Represents initial location type that can be present during add component. More...

enum	PositioningMethod { PositioningMethodAbsoluteOrigin, PositioningMethodOriginToOrigin }
	Represents the positioning method. More...

Public Member Functions
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. More...

virtual NXOpen::ErrorList *	AutoAssignAttributesWithNamingPattern (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::NXObject *	CreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
	Creates a map object of attribute titles to their corresponding naming pattern Created in NX12.0.0. More...

NXOpen::Motion::AddSubmechanismBuilder::Layer	LayerOption ()
	Returns the layers to which geometry are added Created in NX12.0.0. More...

NXOpen::Motion::AddSubmechanismBuilder::PositioningMethod	Positioning ()
	Returns the positioning method. More...

NXOpen::NXObject *	RemappedGeometry ()
	Returns the remapped geometry. More...

bool	RemappingOn ()
	Returns the option of using geometry remapping Created in NX1847.0.0. More...

NXOpen::NXObject *	SelectedPart ()
	Returns the Motion Simulation part to add as sumbechanism Created in NX12.0.0. More...

void	SetLayerOption (NXOpen::Motion::AddSubmechanismBuilder::Layer layerOption)
	Sets the layers to which geometry are added Created in NX12.0.0. More...

void	SetPositioning (NXOpen::Motion::AddSubmechanismBuilder::PositioningMethod positioningMethod)
	Sets the positioning method. More...

void	SetRemappedGeometry (NXOpen::NXObject *geometry)
	Sets the remapped geometry. More...

void	SetRemappingOn (bool remappingOn)
	Sets the option of using geometry remapping Created in NX1847.0.0. More...

void	SetSelectedPart (NXOpen::NXObject *part)
	Sets the Motion Simulation part to add as sumbechanism Created in NX12.0.0. More...

void	SetUserLayer (int layer)
	Sets the user defined layer (should be a value in the range 1-256) Created in NX12.0.0. More...

int	UserLayer ()
	Returns the user defined layer (should be a value in the range 1-256) Created in NX12.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 add submechanism in current context.

To create a new instance of this class, use NXOpen::Motion::MotionSimulation::CreateAddSubmechanismBuilder
Default values.

Property

Value

LayerOption

Original

Positioning

AbsoluteOrigin

UserLayer

1

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::AddSubmechanismBuilder::Layer

Represents initial location type that can be present during add component.

Enumerator
LayerOriginal	the original layer
LayerWork	the work laye
LayerSpecified	custom specified layer

enum NXOpen::Motion::AddSubmechanismBuilder::PositioningMethod

Represents the positioning method.

Enumerator
PositioningMethodAbsoluteOrigin	absolute origin of the current part
PositioningMethodOriginToOrigin	only useful when NXOpen::Motion::AddSubmechanismBuilder::RemappingOn and NXOpen::Motion::AddSubmechanismBuilder::SetRemappingOn is active

Member Function Documentation

virtual NXOpen::ErrorList* NXOpen::Motion::AddSubmechanismBuilder::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.

Created in NX8.5.0.

License requirements : None

Parameters

objects objects

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::ErrorList* NXOpen::Motion::AddSubmechanismBuilder::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

Created in NX12.0.0.

License requirements : None

Parameters

objects	objects
properties	properties

Implements NXOpen::IAttributeSourceObjectBuilder.

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

virtual

Creates a map object of attribute titles to their corresponding naming pattern
Created in NX12.0.0.

License requirements : None

Parameters

attributeTitles	attributetitles
titlePatterns	titlepatterns

Implements NXOpen::IAttributeSourceObjectBuilder.

NXOpen::Motion::AddSubmechanismBuilder::Layer NXOpen::Motion::AddSubmechanismBuilder::LayerOption ( )

Returns the layers to which geometry are added
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::AddSubmechanismBuilder::PositioningMethod NXOpen::Motion::AddSubmechanismBuilder::Positioning ( )

Returns the positioning method.

Created in NX1847.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Motion::AddSubmechanismBuilder::RemappedGeometry ( )

Returns the remapped geometry.

User should set a valid geometry if remaping is on, otherwise this is not used.
Created in NX1847.0.0.

License requirements : None

bool NXOpen::Motion::AddSubmechanismBuilder::RemappingOn ( )

Returns the option of using geometry remapping
Created in NX1847.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Motion::AddSubmechanismBuilder::SelectedPart ( )

Returns the Motion Simulation part to add as sumbechanism
Created in NX12.0.0.

License requirements : None

void NXOpen::Motion::AddSubmechanismBuilder::SetLayerOption ( NXOpen::Motion::AddSubmechanismBuilder::Layer layerOption )

Sets the layers to which geometry are added
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

layerOption layeroption

void NXOpen::Motion::AddSubmechanismBuilder::SetPositioning ( NXOpen::Motion::AddSubmechanismBuilder::PositioningMethod positioningMethod )

Sets the positioning method.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

positioningMethod positioningmethod

void NXOpen::Motion::AddSubmechanismBuilder::SetRemappedGeometry ( NXOpen::NXObject * geometry )

Sets the remapped geometry.

User should set a valid geometry if remaping is on, otherwise this is not used.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

geometry geometry

void NXOpen::Motion::AddSubmechanismBuilder::SetRemappingOn ( bool remappingOn )

Sets the option of using geometry remapping
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

remappingOn remappingon

void NXOpen::Motion::AddSubmechanismBuilder::SetSelectedPart ( NXOpen::NXObject * part )

Sets the Motion Simulation part to add as sumbechanism
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

part part

void NXOpen::Motion::AddSubmechanismBuilder::SetUserLayer ( int layer )

Sets the user defined layer (should be a value in the range 1-256)
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

layer layer

int NXOpen::Motion::AddSubmechanismBuilder::UserLayer ( )

Returns the user defined layer (should be a value in the range 1-256)
Created in NX12.0.0.

License requirements : None

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

Motion_AddSubmechanismBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation