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

Builder for creating a convergent body from CAE.CAEBody
To create a new instance of this class, use NXOpen::CAE::CaePart::CreateConvertToConvergentBodyBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::CAE::ConvertToConvergentBodyBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Option { OptionParentOfFEM, OptionComponentOfCADBody, OptionNewPart, OptionExistingPart }
 Represents the supported export locations of convergent body. More...
 

Public Member Functions

bool Associate ()
 Returns a value indicating whether to associate the convergent body to the polygon body or not
Created in NX12.0.0. More...
 
NXOpen::CAE::SelectCAEBodyListBodySelection ()
 Returns the polygon body selection list inside of FEM part
Created in NX12.0.0. More...
 
NXString ExistingFile ()
 Returns the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0. More...
 
NXString NewFile ()
 Returns the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0. More...
 
void SetAssociate (bool associateToggle)
 Sets a value indicating whether to associate the convergent body to the polygon body or not
Created in NX12.0.0. More...
 
void SetExistingFile (const NXString &filename)
 Sets the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0. More...
 
void SetExistingFile (const char *filename)
 Sets the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0. More...
 
void SetNewFile (const NXString &foldername)
 Sets the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0. More...
 
void SetNewFile (const char *foldername)
 Sets the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0. More...
 
void SetTargetOption (NXOpen::CAE::ConvertToConvergentBodyBuilder::Option targetOptions)
 Sets the target option which indicates where the resulting convergent body will be created
Created in NX12.0.0. More...
 
NXOpen::CAE::ConvertToConvergentBodyBuilder::Option TargetOption ()
 Returns the target option which indicates where the resulting convergent body will be created
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

Builder for creating a convergent body from CAE.CAEBody
To create a new instance of this class, use NXOpen::CAE::CaePart::CreateConvertToConvergentBodyBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Represents the supported export locations of convergent body.

Enumerator
OptionParentOfFEM 

The immediate parent of the current FEM Part.

OptionComponentOfCADBody 

The orginal component inside of assembly that polygon body is derived from in FEM Part.

OptionNewPart 

The new part where the convergent body in the FEM part will be exported to.

OptionExistingPart 

The existing part where the convergent body in the FEM part will be exported to.

Member Function Documentation

bool NXOpen::CAE::ConvertToConvergentBodyBuilder::Associate ( )

Returns a value indicating whether to associate the convergent body to the polygon body or not
Created in NX12.0.0.



License requirements : None

NXOpen::CAE::SelectCAEBodyList* NXOpen::CAE::ConvertToConvergentBodyBuilder::BodySelection ( )

Returns the polygon body selection list inside of FEM part
Created in NX12.0.0.



License requirements : None

NXString NXOpen::CAE::ConvertToConvergentBodyBuilder::ExistingFile ( )

Returns the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0.



License requirements : None

NXString NXOpen::CAE::ConvertToConvergentBodyBuilder::NewFile ( )

Returns the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetAssociate ( bool  associateToggle)

Sets a value indicating whether to associate the convergent body to the polygon body or not
Created in NX12.0.0.



License requirements : None

Parameters
associateToggleassociatetoggle
void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetExistingFile ( const NXString filename)

Sets the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetExistingFile ( const char *  filename)

Sets the existing part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionExistingPart
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetNewFile ( const NXString foldername)

Sets the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0.



License requirements : None

Parameters
foldernamefoldername
void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetNewFile ( const char *  foldername)

Sets the new part file name which is required if NXOpen::CAE::ConvertToConvergentBodyBuilder::Option is set to CAE::ConvertToConvergentBodyBuilder::OptionNewPart
Created in NX12.0.0.



License requirements : None

Parameters
foldernamefoldername
void NXOpen::CAE::ConvertToConvergentBodyBuilder::SetTargetOption ( NXOpen::CAE::ConvertToConvergentBodyBuilder::Option  targetOptions)

Sets the target option which indicates where the resulting convergent body will be created
Created in NX12.0.0.



License requirements : None

Parameters
targetOptionstargetoptions
NXOpen::CAE::ConvertToConvergentBodyBuilder::Option NXOpen::CAE::ConvertToConvergentBodyBuilder::TargetOption ( )

Returns the target option which indicates where the resulting convergent body will be created
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.