CoolingDefineChannelBuilder Class¶
-
class
NXOpen.Tooling.
CoolingDefineChannelBuilder
¶ Bases:
NXOpen.Builder
The builder class for Cooling Define Channel which assists you to create channels directly.
To create a new instance of this class, use
NXOpen.Tooling.CoolingDefineChannelCollection.CreateCoolingDefineChannelBuilder
Default values.
Property Value AdjustBoundaryChannel 0 Diameter.Value 10 (millimeters part), 0.375 (inches part) ExtensionSolution NoExtension Motion.DeltaEnum ReferenceWcsWorkPart Motion.DeltaXc.Value 0.0 Motion.DeltaYc.Value 0.0 Motion.DeltaZc.Value 0.0 TipAngle.Value 118 TipEndType None New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AdjustBoundaryChannel | Returns or sets the flag to indicate whether to extend boundary channel or not |
ChannelDiameter | Returns or sets the channel diameter |
Diameter | Returns the channel diameter |
ExtensionSolution | Returns or sets the candidate extension types |
LimitBody | Returns the boundary body |
Motion | Returns the object which defines the transformation from start point to end point. |
StartPoint | Returns or sets the point as the start position of the channel. |
Tag | Returns the Tag for this object. |
TipAngle | Returns the value for the tip angle of the channel. |
TipEndType | Returns or sets the candidate of tip end type |
Type | Returns or sets the type of attributes assigned to the created body attribute type values. |
Methods¶
Method | Description |
---|---|
AutoGetBoundaryBody | Gets the boundary body automatically |
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. |
SetAutoSelectBoundary | Sets the value that whether the boundary body is automatically got or not |
SetBoundaryBody | Sets the boundary body to do channel extension |
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. |
Enumerations¶
CoolingDefineChannelBuilderExtensionTypes Enumeration | The extension types of channel |
CoolingDefineChannelBuilderTipEndTypes Enumeration | The tip end types of channel |
CoolingDefineChannelBuilderTypes Enumeration | Types to specify how to assign attributes to the created body. |
Property Detail¶
AdjustBoundaryChannel¶
-
CoolingDefineChannelBuilder.
AdjustBoundaryChannel
¶ Returns or sets the flag to indicate whether to extend boundary channel or not
-------------------------------------
Getter Method
Signature
AdjustBoundaryChannel()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AdjustBoundaryChannel(adjustBoundaryChannel)
Parameters: adjustBoundaryChannel (bool) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”)
ChannelDiameter¶
-
CoolingDefineChannelBuilder.
ChannelDiameter
¶ Returns or sets the channel diameter
-------------------------------------
Getter Method
Signature
ChannelDiameter()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ChannelDiameter(channelDiameter)
Parameters: channelDiameter (float) – New in version NX7.5.0.
License requirements: None.
Diameter¶
-
CoolingDefineChannelBuilder.
Diameter
¶ Returns the channel diameter
-------------------------------------
Getter Method
Signature
Diameter()
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
ExtensionSolution¶
-
CoolingDefineChannelBuilder.
ExtensionSolution
¶ Returns or sets the candidate extension types
-------------------------------------
Getter Method
Signature
ExtensionSolution()
Returns: Return type: NXOpen.Tooling.CoolingDefineChannelBuilderExtensionTypes
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtensionSolution(extensionSolution)
Parameters: extensionSolution ( NXOpen.Tooling.CoolingDefineChannelBuilderExtensionTypes
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”)
LimitBody¶
-
CoolingDefineChannelBuilder.
LimitBody
¶ Returns the boundary body
-------------------------------------
Getter Method
Signature
LimitBody()
Returns: Return type: NXOpen.SelectBody
New in version NX8.5.0.
License requirements: None.
Motion¶
-
CoolingDefineChannelBuilder.
Motion
¶ Returns the object which defines the transformation from start point to end point.
-------------------------------------
Getter Method
Signature
Motion()
Returns: Return type: NXOpen.GeometricUtilities.ModlMotion
New in version NX7.5.0.
License requirements: None.
StartPoint¶
-
CoolingDefineChannelBuilder.
StartPoint
¶ Returns or sets the point as the start position of the channel.
-------------------------------------
Getter Method
Signature
StartPoint()
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartPoint(startPoint)
Parameters: startPoint ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: None.
TipAngle¶
-
CoolingDefineChannelBuilder.
TipAngle
¶ Returns the value for the tip angle of the channel.
-------------------------------------
Getter Method
Signature
TipAngle()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
TipEndType¶
-
CoolingDefineChannelBuilder.
TipEndType
¶ Returns or sets the candidate of tip end type
-------------------------------------
Getter Method
Signature
TipEndType()
Returns: Return type: NXOpen.Tooling.CoolingDefineChannelBuilderTipEndTypes
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TipEndType(tipEndType)
Parameters: tipEndType ( NXOpen.Tooling.CoolingDefineChannelBuilderTipEndTypes
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”)
Type¶
-
CoolingDefineChannelBuilder.
Type
¶ Returns or sets the type of attributes assigned to the created body attribute type values.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Tooling.CoolingDefineChannelBuilderTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Tooling.CoolingDefineChannelBuilderTypes
) –New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”)
Method Detail¶
AutoGetBoundaryBody¶
-
CoolingDefineChannelBuilder.
AutoGetBoundaryBody
¶ Gets the boundary body automatically
Signature
AutoGetBoundaryBody()
New in version NX8.5.0.
License requirements: None.
SetAutoSelectBoundary¶
-
CoolingDefineChannelBuilder.
SetAutoSelectBoundary
¶ Sets the value that whether the boundary body is automatically got or not
Signature
SetAutoSelectBoundary(autoSelectBoundary)
Parameters: autoSelectBoundary (bool) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”)
SetBoundaryBody¶
-
CoolingDefineChannelBuilder.
SetBoundaryBody
¶ Sets the boundary body to do channel extension
Signature
SetBoundaryBody(body)
Parameters: body ( NXOpen.Body
) – the body set as boundary bodyNew in version NX8.5.0.
License requirements: None.
Validate¶
-
CoolingDefineChannelBuilder.
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.