AutoBCBuilder Class

class NXOpen.CAE.AutoBCBuilder

Bases: NXOpen.Builder

Builds one or more NXOpen.CAE.SimSimulationObject object(s).

These simulation objects use two target face sets like the Surf to Surf Contact

To create a new instance of this class, use NXOpen.CAE.SimSimulation.CreateAutoBcBuilder()

New in version NX5.0.0.

Properties

Property Description
Autopairs Returns or sets the AutoBC’s NXOpen.CAE.AutoPairs
BcBaseName Returns or sets the base name of NXOpen.CAE.SimBC objects created
DestinationFolder Returns or sets the destination folder of NXOpen.CAE.SimBC object
Label Returns or sets the initial label of NXOpen.CAE.CaeRegion and NXOpen.CAE.SimBC objects
PropertyTable Returns the AutoBC’s NXOpen.CAE.PropertyTable
Recipe Returns the AutoBC’s NXOpen.CAE.SimAutoBcRecipe
RetainRecipeFlag Returns or sets the retain recipe flag, which signifies whether or not the recipe will be retained after the generation of the BCs
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Autopairs

AutoBCBuilder.Autopairs

Returns or sets the AutoBC’s NXOpen.CAE.AutoPairs

-------------------------------------

Getter Method

Signature Autopairs

Returns:auto pairs object
Return type:NXOpen.CAE.AutoPairs

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Autopairs

Parameters:recipe (NXOpen.CAE.AutoPairs) – auto pairs object

New in version NX5.0.0.

License requirements: None.

BcBaseName

AutoBCBuilder.BcBaseName

Returns or sets the base name of NXOpen.CAE.SimBC objects created

-------------------------------------

Getter Method

Signature BcBaseName

Returns:the base name
Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BcBaseName

Parameters:name (str) – the base name, if None or blank, a base name will be generated

New in version NX8.0.0.

License requirements: None.

DestinationFolder

AutoBCBuilder.DestinationFolder

Returns or sets the destination folder of NXOpen.CAE.SimBC object

-------------------------------------

Getter Method

Signature DestinationFolder

Returns:destination folder
Return type:NXOpen.CAE.SimLbcFolder

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DestinationFolder

Parameters:folder (NXOpen.CAE.SimLbcFolder) – destination folder

New in version NX9.0.0.

License requirements: None.

Label

AutoBCBuilder.Label

Returns or sets the initial label of NXOpen.CAE.CaeRegion and NXOpen.CAE.SimBC objects

-------------------------------------

Getter Method

Signature Label

Returns:the initial label
Return type:int

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Label

Parameters:label (int) – the initial label, if <=0 unique labels will be generated for you

New in version NX8.0.0.

License requirements: None.

PropertyTable

AutoBCBuilder.PropertyTable

Returns the AutoBC’s NXOpen.CAE.PropertyTable

-------------------------------------

Getter Method

Signature PropertyTable

Returns:
Return type:NXOpen.CAE.PropertyTable

New in version NX5.0.0.

License requirements: None.

Recipe

AutoBCBuilder.Recipe

Returns the AutoBC’s NXOpen.CAE.SimAutoBcRecipe

-------------------------------------

Getter Method

Signature Recipe

Returns:auto BC recipe
Return type:NXOpen.CAE.SimAutoBcRecipe

New in version NX5.0.0.

License requirements: None.

RetainRecipeFlag

AutoBCBuilder.RetainRecipeFlag

Returns or sets the retain recipe flag, which signifies whether or not the recipe will be retained after the generation of the BCs

-------------------------------------

Getter Method

Signature RetainRecipeFlag

Returns:flag for retaining recipe or not
Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RetainRecipeFlag

Parameters:retainRecipe (bool) – flag for retaining recipe or not

New in version NX5.0.0.

License requirements: None.

Method Detail

Validate

AutoBCBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.