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

Represents a NXOpen::Assemblies::CreateNewComponentBuilder builder class. More...

Inheritance diagram for NXOpen::Assemblies::CreateNewComponentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ComponentCamType { ComponentCamTypeTarget, ComponentCamTypeResource, ComponentCamTypeWorkpiece }
 Set the origin type. More...
 
enum  ComponentLayerOptionType { ComponentLayerOptionTypeOriginal, ComponentLayerOptionTypeWork, ComponentLayerOptionTypeAsSpecified }
 Set the layer option type. More...
 
enum  ComponentOriginType { ComponentOriginTypeWcs, ComponentOriginTypeAbsolute }
 Set the cam component type. More...
 
enum  ComponentReferenceSetType { ComponentReferenceSetTypeModel, ComponentReferenceSetTypeEntirePartOnly, ComponentReferenceSetTypeOther }
 Set the reference set. More...
 

Public Member Functions

NXOpen::Assemblies::CreateNewComponentBuilder::ComponentCamType ComponentCam ()
 Returns the cam component cam type
Created in NX6.0.0. More...
 
NXOpen::Assemblies::CreateNewComponentBuilder::ComponentOriginType ComponentOrigin ()
 Returns the component origin
Created in NX6.0.0. More...
 
bool DefiningObjectsAdded ()
 Returns the defining objects added toggle
Created in NX6.0.0. More...
 
int LayerNumber ()
 Returns the layer number
Created in NX6.0.0. More...
 
NXOpen::Assemblies::CreateNewComponentBuilder::ComponentLayerOptionType LayerOption ()
 Returns the layer option
Created in NX6.0.0. More...
 
NXString NewComponentName ()
 Returns the new component name
Created in NX6.0.0. More...
 
NXOpen::FileNewNewFile ()
 Returns the file new object is get and set
Created in NX6.0.0. More...
 
NXOpen::SelectDisplayableObjectListObjectForNewComponent ()
 Returns the objects for select block
Created in NX6.0.0. More...
 
bool OriginalObjectsDeleted ()
 Returns the original objects deleted
Created in NX6.0.0. More...
 
NXOpen::Assemblies::CreateNewComponentBuilder::ComponentReferenceSetType ReferenceSet ()
 Returns the reference set
Created in NX6.0.0. More...
 
NXString ReferenceSetName ()
 Returns the reference set name. More...
 
void SetComponentCam (NXOpen::Assemblies::CreateNewComponentBuilder::ComponentCamType componentCam)
 Sets the cam component cam type
Created in NX6.0.0. More...
 
void SetComponentOrigin (NXOpen::Assemblies::CreateNewComponentBuilder::ComponentOriginType componentOrigin)
 Sets the component origin
Created in NX6.0.0. More...
 
void SetDefiningObjectsAdded (bool definingObjectsAdded)
 Sets the defining objects added toggle
Created in NX6.0.0. More...
 
void SetLayerNumber (int layerNumber)
 Sets the layer number
Created in NX6.0.0. More...
 
void SetLayerOption (NXOpen::Assemblies::CreateNewComponentBuilder::ComponentLayerOptionType layerOption)
 Sets the layer option
Created in NX6.0.0. More...
 
void SetNewComponentName (const NXString &newComponentName)
 Sets the new component name
Created in NX6.0.0. More...
 
void SetNewComponentName (const char *newComponentName)
 Sets the new component name
Created in NX6.0.0. More...
 
void SetNewFile (NXOpen::FileNew *fileNew)
 Sets the file new object is get and set
Created in NX6.0.0. More...
 
void SetOriginalObjectsDeleted (bool originalObjectsDeleted)
 Sets the original objects deleted
Created in NX6.0.0. More...
 
void SetReferenceSet (NXOpen::Assemblies::CreateNewComponentBuilder::ComponentReferenceSetType referenceSet)
 Sets the reference set
Created in NX6.0.0. More...
 
void SetReferenceSetName (const NXString &referenceSetName)
 Sets the reference set name. More...
 
void SetReferenceSetName (const char *referenceSetName)
 Sets the reference set name. 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 NXOpen::Assemblies::CreateNewComponentBuilder builder class.

Input to this class can be PSM facet objects.
To create a new instance of this class, use NXOpen::Assemblies::AssemblyManager::CreateNewComponentBuilder
Default values.

Property Value

ComponentCam

Target

ComponentOrigin

Wcs

DefiningObjectsAdded

1

LayerNumber

1

LayerOption

Original

OriginalObjectsDeleted

1

ReferenceSet

Model


Created in NX6.0.0.

Member Enumeration Documentation

Set the origin type.

Enumerator
ComponentCamTypeTarget 

Set the origin type to target.

ComponentCamTypeResource 

Set the component type to resource.

ComponentCamTypeWorkpiece 

Set the component type to workpiece.

Set the layer option type.

Enumerator
ComponentLayerOptionTypeOriginal 

Set the layer option type to original.

ComponentLayerOptionTypeWork 

Set the layer option type to work.

ComponentLayerOptionTypeAsSpecified 

Set the layer option type to as specified.

Set the cam component type.

Enumerator
ComponentOriginTypeWcs 

Set the origin type to wcs.

ComponentOriginTypeAbsolute 

Set the origin type to absolute.

Set the reference set.

Enumerator
ComponentReferenceSetTypeModel 

Set the reference set to model.

ComponentReferenceSetTypeEntirePartOnly 

Set the reference set to entire part only.

ComponentReferenceSetTypeOther 

Set the reference to other.

Member Function Documentation

NXOpen::Assemblies::CreateNewComponentBuilder::ComponentCamType NXOpen::Assemblies::CreateNewComponentBuilder::ComponentCam ( )

Returns the cam component cam type
Created in NX6.0.0.



License requirements : None

NXOpen::Assemblies::CreateNewComponentBuilder::ComponentOriginType NXOpen::Assemblies::CreateNewComponentBuilder::ComponentOrigin ( )

Returns the component origin
Created in NX6.0.0.



License requirements : None

bool NXOpen::Assemblies::CreateNewComponentBuilder::DefiningObjectsAdded ( )

Returns the defining objects added toggle
Created in NX6.0.0.



License requirements : None

int NXOpen::Assemblies::CreateNewComponentBuilder::LayerNumber ( )

Returns the layer number
Created in NX6.0.0.



License requirements : None

NXOpen::Assemblies::CreateNewComponentBuilder::ComponentLayerOptionType NXOpen::Assemblies::CreateNewComponentBuilder::LayerOption ( )

Returns the layer option
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Assemblies::CreateNewComponentBuilder::NewComponentName ( )

Returns the new component name
Created in NX6.0.0.



License requirements : None

NXOpen::FileNew* NXOpen::Assemblies::CreateNewComponentBuilder::NewFile ( )

Returns the file new object is get and set
Created in NX6.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::CreateNewComponentBuilder::ObjectForNewComponent ( )

Returns the objects for select block
Created in NX6.0.0.



License requirements : None

bool NXOpen::Assemblies::CreateNewComponentBuilder::OriginalObjectsDeleted ( )

Returns the original objects deleted
Created in NX6.0.0.



License requirements : None

NXOpen::Assemblies::CreateNewComponentBuilder::ComponentReferenceSetType NXOpen::Assemblies::CreateNewComponentBuilder::ReferenceSet ( )

Returns the reference set
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Assemblies::CreateNewComponentBuilder::ReferenceSetName ( )

Returns the reference set name.

This should be used when reference set type is set to other
Created in NX6.0.0.

License requirements : None

void NXOpen::Assemblies::CreateNewComponentBuilder::SetComponentCam ( NXOpen::Assemblies::CreateNewComponentBuilder::ComponentCamType  componentCam)

Sets the cam component cam type
Created in NX6.0.0.



License requirements : None

Parameters
componentCamcomponentcam
void NXOpen::Assemblies::CreateNewComponentBuilder::SetComponentOrigin ( NXOpen::Assemblies::CreateNewComponentBuilder::ComponentOriginType  componentOrigin)

Sets the component origin
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
componentOrigincomponentorigin
void NXOpen::Assemblies::CreateNewComponentBuilder::SetDefiningObjectsAdded ( bool  definingObjectsAdded)

Sets the defining objects added toggle
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
definingObjectsAddeddefiningobjectsadded
void NXOpen::Assemblies::CreateNewComponentBuilder::SetLayerNumber ( int  layerNumber)

Sets the layer number
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
layerNumberlayernumber
void NXOpen::Assemblies::CreateNewComponentBuilder::SetLayerOption ( NXOpen::Assemblies::CreateNewComponentBuilder::ComponentLayerOptionType  layerOption)

Sets the layer option
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
layerOptionlayeroption
void NXOpen::Assemblies::CreateNewComponentBuilder::SetNewComponentName ( const NXString newComponentName)

Sets the new component name
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
newComponentNamenewcomponentname
void NXOpen::Assemblies::CreateNewComponentBuilder::SetNewComponentName ( const char *  newComponentName)

Sets the new component name
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
newComponentNamenewcomponentname
void NXOpen::Assemblies::CreateNewComponentBuilder::SetNewFile ( NXOpen::FileNew fileNew)

Sets the file new object is get and set
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
fileNewfilenew
void NXOpen::Assemblies::CreateNewComponentBuilder::SetOriginalObjectsDeleted ( bool  originalObjectsDeleted)

Sets the original objects deleted
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
originalObjectsDeletedoriginalobjectsdeleted
void NXOpen::Assemblies::CreateNewComponentBuilder::SetReferenceSet ( NXOpen::Assemblies::CreateNewComponentBuilder::ComponentReferenceSetType  referenceSet)

Sets the reference set
Created in NX6.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
referenceSetGet the reference set
void NXOpen::Assemblies::CreateNewComponentBuilder::SetReferenceSetName ( const NXString referenceSetName)

Sets the reference set name.

This should be used when reference set type is set to other
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
referenceSetNamereferencesetname
void NXOpen::Assemblies::CreateNewComponentBuilder::SetReferenceSetName ( const char *  referenceSetName)

Sets the reference set name.

This should be used when reference set type is set to other
Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
referenceSetNamereferencesetname

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