NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Tooling::SpecifyCircuitBuilder Class Reference

Represents a builder to be used to create specify circuit. More...

Inheritance diagram for NXOpen::Tooling::SpecifyCircuitBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::NXColorChannelColor ()
 Returns the circuit channel body color. More...
 
void CheckStatus ()
 Check whether cooling circuit is finished or not. More...
 
NXOpen::NXColorCircuitColor ()
 Returns the circuit channel temperary body color. More...
 
NXOpen::Tooling::CoolingFittingDataCreateCoolingFittingData ()
 Creates the cooling fitting data object. More...
 
bool CreateFittings ()
 Returns the value which specifies whether to add fittings or not. More...
 
std::vector< double > GetCircuitColor ()
 Returns the circuit channel body color. More...
 
NXOpen::Tooling::CoolingFittingDataGetCoolingFittingData ()
 Gets the Cooling Fitting Data object. More...
 
void GetOneCircuit (const std::vector< NXOpen::Body * > &channels)
 Gets intersect cooling list value. More...
 
void InitializeCircuitSetData ()
 Initializes the circuit set data. More...
 
NXOpen::SelectBodyListInletChannel ()
 Returns the inlet channel. More...
 
bool KeepCircuit ()
 Returns the option whether to keep the circuit displayed body. More...
 
int Layer ()
 Returns the layer value for the selected channels. More...
 
NXOpen::SelectBodyOutletChannel ()
 Returns the outlet channel. More...
 
void SetChannelColor (NXOpen::NXColor *channelColor)
 Sets the circuit channel body color. More...
 
void SetCircuitColor (NXOpen::NXColor *circuitColor)
 Sets the circuit channel temperary body color. More...
 
void SetCircuitColor (const std::vector< double > &circuitColor)
 Sets the circuit color. More...
 
void SetCreateFittings (bool createFittings)
 Sets the value which specifies whether to add fittings or not. More...
 
void SetKeepCircuit (bool keepCircuit)
 Sets the option whether to keep the circuit displayed body. More...
 
void SetLayer (int layer)
 Sets the layer value for the selected channels. More...
 
void SetUseSymbol (bool useSymbol)
 Sets the value which specifies whether to add real component or not. More...
 
bool UseSymbol ()
 Returns the value which specifies whether to add real component or not. 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 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


Created in NX8.0.0.

Member Function Documentation

NXOpen::NXColor* NXOpen::Tooling::SpecifyCircuitBuilder::ChannelColor ( )

Returns the circuit channel body color.


Created in NX10.0.0.

License requirements : None

void NXOpen::Tooling::SpecifyCircuitBuilder::CheckStatus ( )

Check whether cooling circuit is finished or not.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

NXOpen::NXColor* NXOpen::Tooling::SpecifyCircuitBuilder::CircuitColor ( )

Returns the circuit channel temperary body color.


Created in NX8.0.1.

License requirements : None

NXOpen::Tooling::CoolingFittingData* NXOpen::Tooling::SpecifyCircuitBuilder::CreateCoolingFittingData ( )

Creates the cooling fitting data object.

Returns
the new NXOpen::Tooling::CoolingFittingData instance
Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")
bool NXOpen::Tooling::SpecifyCircuitBuilder::CreateFittings ( )

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


Created in NX11.0.0.

License requirements : None

std::vector<double> NXOpen::Tooling::SpecifyCircuitBuilder::GetCircuitColor ( )

Returns the circuit channel body color.

Returns
Array of 3 RGB values, each between 0 and 1
Created in NX8.0.0.

License requirements : None
NXOpen::Tooling::CoolingFittingData* NXOpen::Tooling::SpecifyCircuitBuilder::GetCoolingFittingData ( )

Gets the Cooling Fitting Data object.

Returns

Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")
void NXOpen::Tooling::SpecifyCircuitBuilder::GetOneCircuit ( const std::vector< NXOpen::Body * > &  channels)

Gets intersect cooling list value.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
channelsthe cooling body
void NXOpen::Tooling::SpecifyCircuitBuilder::InitializeCircuitSetData ( )

Initializes the circuit set data.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

NXOpen::SelectBodyList* NXOpen::Tooling::SpecifyCircuitBuilder::InletChannel ( )

Returns the inlet channel.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::SpecifyCircuitBuilder::KeepCircuit ( )

Returns the option whether to keep the circuit displayed body.


Created in NX8.0.0.

License requirements : None

int NXOpen::Tooling::SpecifyCircuitBuilder::Layer ( )

Returns the layer value for the selected channels.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Tooling::SpecifyCircuitBuilder::OutletChannel ( )

Returns the outlet channel.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::SpecifyCircuitBuilder::SetChannelColor ( NXOpen::NXColor channelColor)

Sets the circuit channel body color.


Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
channelColorchannelcolor
void NXOpen::Tooling::SpecifyCircuitBuilder::SetCircuitColor ( NXOpen::NXColor circuitColor)

Sets the circuit channel temperary body color.


Created in NX8.0.1.

License requirements : ug_mold_design ("UG MOLD")

Parameters
circuitColorcircuitcolor
void NXOpen::Tooling::SpecifyCircuitBuilder::SetCircuitColor ( const std::vector< double > &  circuitColor)

Sets the circuit color.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
circuitColorArray of 3 RGB values, each between 0 and 1
void NXOpen::Tooling::SpecifyCircuitBuilder::SetCreateFittings ( bool  createFittings)

Sets the value which specifies whether to add fittings or not.


Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
createFittingscreatefittings
void NXOpen::Tooling::SpecifyCircuitBuilder::SetKeepCircuit ( bool  keepCircuit)

Sets the option whether to keep the circuit displayed body.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
keepCircuitkeepcircuit
void NXOpen::Tooling::SpecifyCircuitBuilder::SetLayer ( int  layer)

Sets the layer value for the selected channels.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
layerlayer
void NXOpen::Tooling::SpecifyCircuitBuilder::SetUseSymbol ( bool  useSymbol)

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


Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
useSymbolusesymbol
bool NXOpen::Tooling::SpecifyCircuitBuilder::UseSymbol ( )

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


Created in NX10.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.