NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Motion::AddSubmechanismBuilder Class Reference

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

Inheritance diagram for NXOpen::Motion::AddSubmechanismBuilder:
NXOpen::Builder NXOpen::IAttributeSourceObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

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

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...
 
NXOpen::Motion::AddSubmechanismBuilder::Layer LayerOption ()
 Returns the layers to which geometry are added
Created in NX12.0.0. More...
 
NXOpen::NXObjectSelectedPart ()
 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 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::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 add submechanism in current context.


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

Property Value

LayerOption

Original

UserLayer

1


Created in NX12.0.0.

Member Enumeration Documentation

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

Enumerator
LayerOriginal 

the original layer

LayerWork 

the work laye

LayerSpecified 

custom specified layer

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.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
objectsobjects

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

Returns

Created in NX12.0.0.

License requirements : None
Parameters
objectsobjects
propertiesproperties

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.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
attributeTitlesattributetitles
titlePatternstitlepatterns

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::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
layerOptionlayeroption
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
partpart
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
layerlayer
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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.