SpecifyCircuitBuilder Class

class NXOpen.Tooling.SpecifyCircuitBuilder

Bases: NXOpen.Builder

Represents a builder to be used to create specify circuit.

To create a new instance of this class, use NXOpen.Tooling.SpecifyCircuitCollection.CreateBuilder()

Default values.

Property	Value
CreateFittings	1
KeepCircuit	0
Layer	251
UseSymbol	1

New in version NX8.0.0.

Properties

Property	Description
ChannelColor	Returns or sets the circuit channel body color.
CircuitColor	Returns or sets the circuit channel temperary body color.
CreateFittings	Returns or sets the value which specifies whether to add fittings or not.
InletChannel	Returns the inlet channel.
KeepCircuit	Returns or sets the option whether to keep the circuit displayed body.
Layer	Returns or sets the layer value for the selected channels.
OutletChannel	Returns the outlet channel.
Tag	Returns the Tag for this object.
UseSymbol	Returns or sets the value which specifies whether to add real component or not.

Methods

Method	Description
CheckStatus	Check whether cooling circuit is finished or not.
Commit	Commits any edits that have been applied to the builder.
CreateCoolingFittingData	Creates the cooling fitting data object.
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.
GetCoolingFittingData	Gets the Cooling Fitting Data object.
GetObject	Returns the object currently being edited by this builder.
GetOneCircuit	Gets intersect cooling list value.
InitializeCircuitSetData	Initializes the circuit set data.
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

ChannelColor

SpecifyCircuitBuilder.ChannelColor

Returns or sets the circuit channel body color.

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

Getter Method

Signature ChannelColor

Returns: Return type:Id

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ChannelColor

Parameters:channelColor (Id) –

New in version NX10.0.0.

License requirements: ug_mold_design (“UG MOLD”)

CircuitColor

SpecifyCircuitBuilder.CircuitColor

Returns or sets the circuit channel temperary body color.

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

Getter Method

Signature CircuitColor

Returns: Return type:Id

New in version NX8.0.1.

License requirements: None.

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

Setter Method

Signature CircuitColor

Parameters:circuitColor (Id) –

New in version NX8.0.1.

License requirements: ug_mold_design (“UG MOLD”)

CreateFittings

SpecifyCircuitBuilder.CreateFittings

Returns or sets the value which specifies whether to add fittings or not.

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

Getter Method

Signature CreateFittings

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature CreateFittings

Parameters:createFittings (bool) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

InletChannel

SpecifyCircuitBuilder.InletChannel

Returns the inlet channel.

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

Getter Method

Signature InletChannel

Returns: Return type:NXOpen.SelectBodyList

New in version NX8.0.0.

License requirements: None.

KeepCircuit

SpecifyCircuitBuilder.KeepCircuit

Returns or sets the option whether to keep the circuit displayed body.

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

Getter Method

Signature KeepCircuit

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature KeepCircuit

Parameters:keepCircuit (bool) –

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

Layer

SpecifyCircuitBuilder.Layer

Returns or sets the layer value for the selected channels.

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

Getter Method

Signature Layer

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Layer

Parameters:layer (int) –

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

OutletChannel

SpecifyCircuitBuilder.OutletChannel

Returns the outlet channel.

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

Getter Method

Signature OutletChannel

Returns: Return type:NXOpen.SelectBody

New in version NX8.0.0.

License requirements: None.

UseSymbol

SpecifyCircuitBuilder.UseSymbol

Returns or sets the value which specifies whether to add real component or not.

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

Getter Method

Signature UseSymbol

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature UseSymbol

Parameters:useSymbol (bool) –

New in version NX10.0.0.

License requirements: ug_mold_design (“UG MOLD”)

Method Detail

CheckStatus

SpecifyCircuitBuilder.CheckStatus

Check whether cooling circuit is finished or not.

Signature CheckStatus()

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

CreateCoolingFittingData

SpecifyCircuitBuilder.CreateCoolingFittingData

Creates the cooling fitting data object.

Signature CreateCoolingFittingData()

Returns:the new NXOpen.Tooling.CoolingFittingData instance Return type:NXOpen.Tooling.CoolingFittingData

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

GetCoolingFittingData

SpecifyCircuitBuilder.GetCoolingFittingData

Gets the Cooling Fitting Data object.

Signature GetCoolingFittingData()

Returns: Return type:NXOpen.Tooling.CoolingFittingData

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

GetOneCircuit

SpecifyCircuitBuilder.GetOneCircuit

Gets intersect cooling list value.

Signature GetOneCircuit(channels)

Parameters:channels (list of NXOpen.Body) – the cooling body

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

InitializeCircuitSetData

SpecifyCircuitBuilder.InitializeCircuitSetData

Initializes the circuit set data.

Signature InitializeCircuitSetData()

New in version NX8.0.0.

License requirements: ug_mold_design (“UG MOLD”)

Validate

SpecifyCircuitBuilder.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.