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

The builder class for Cooling Define Channel which assists you to create channels directly. More...

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

Public Types

enum  ExtensionTypes { ExtensionTypesNoExtension, ExtensionTypesAlongExtrusionDirection, ExtensionTypesAlongReverseExtrusionDirection, ExtensionTypesAlongBothDirections }
 The extension types of channel. More...
 
enum  TipEndTypes { TipEndTypesNone, TipEndTypesAngle, TipEndTypesRound }
 The tip end types of channel. More...
 
enum  Types { TypesChannel, TypesBaffle }
 Types to specify how to assign attributes to the created body. More...
 

Public Member Functions

bool AdjustBoundaryChannel ()
 Returns the flag to indicate whether to extend boundary channel or not
Created in NX8.5.0. More...
 
void AutoGetBoundaryBody ()
 Gets the boundary body automatically
Created in NX8.5.0. More...
 
double ChannelDiameter ()
 Returns the channel diameter
Created in NX7.5.0. More...
 
NXOpen::ExpressionDiameter ()
 Returns the channel diameter
Created in NX10.0.0. More...
 
NXOpen::Tooling::CoolingDefineChannelBuilder::ExtensionTypes ExtensionSolution ()
 Returns the candidate extension types
Created in NX8.5.0. More...
 
NXOpen::SelectBodyLimitBody ()
 Returns the boundary body
Created in NX8.5.0. More...
 
NXOpen::GeometricUtilities::ModlMotionMotion ()
 Returns the object which defines the transformation from start point to end point. More...
 
bool RemoveParameter ()
 Returns the flag to indicate whether to remove parameters of the created solid or not
Created in NX12.0.0. More...
 
void SetAdjustBoundaryChannel (bool adjustBoundaryChannel)
 Sets the flag to indicate whether to extend boundary channel or not
Created in NX8.5.0. More...
 
void SetAutoSelectBoundary (bool autoSelectBoundary)
 Sets the value that whether the boundary body is automatically got or not
Created in NX8.5.0. More...
 
void SetBoundaryBody (NXOpen::Body *body)
 Sets the boundary body to do channel extension
Created in NX8.5.0. More...
 
void SetChannelDiameter (double channelDiameter)
 Sets the channel diameter
Created in NX7.5.0. More...
 
void SetExtensionSolution (NXOpen::Tooling::CoolingDefineChannelBuilder::ExtensionTypes extensionSolution)
 Sets the candidate extension types
Created in NX8.5.0. More...
 
void SetRemoveParameter (bool removeParameter)
 Sets the flag to indicate whether to remove parameters of the created solid or not
Created in NX12.0.0. More...
 
void SetStartPoint (NXOpen::Point *startPoint)
 Sets the point as the start position of the channel. More...
 
void SetTipEndType (NXOpen::Tooling::CoolingDefineChannelBuilder::TipEndTypes tipEndType)
 Sets the candidate of tip end type
Created in NX8.5.0. More...
 
void SetType (NXOpen::Tooling::CoolingDefineChannelBuilder::Types type)
 Sets the type of attributes assigned to the created body attribute type values. More...
 
NXOpen::PointStartPoint ()
 Returns the point as the start position of the channel. More...
 
NXOpen::ExpressionTipAngle ()
 Returns the value for the tip angle of the channel. More...
 
NXOpen::Tooling::CoolingDefineChannelBuilder::TipEndTypes TipEndType ()
 Returns the candidate of tip end type
Created in NX8.5.0. More...
 
NXOpen::Tooling::CoolingDefineChannelBuilder::Types Type ()
 Returns the type of attributes assigned to the created body attribute type values. 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

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

RemoveParameter

0

TipAngle.Value

118

TipEndType

None


Created in NX7.5.0.

Member Enumeration Documentation

The extension types of channel.

Enumerator
ExtensionTypesNoExtension 

No extension.

ExtensionTypesAlongExtrusionDirection 

Extend channel to boundary body along the extrusion direction.

ExtensionTypesAlongReverseExtrusionDirection 

Extend channel to boundary body along the reverse extrusion direction.

ExtensionTypesAlongBothDirections 

Extend channel to boundary body along both direction.

The tip end types of channel.

Enumerator
TipEndTypesNone 

No tip angle.

TipEndTypesAngle 

Angle tip.

TipEndTypesRound 

Round tip.

Types to specify how to assign attributes to the created body.

Enumerator
TypesChannel 

channel

TypesBaffle 

baffle

Member Function Documentation

bool NXOpen::Tooling::CoolingDefineChannelBuilder::AdjustBoundaryChannel ( )

Returns the flag to indicate whether to extend boundary channel or not
Created in NX8.5.0.



License requirements : None

void NXOpen::Tooling::CoolingDefineChannelBuilder::AutoGetBoundaryBody ( )

Gets the boundary body automatically
Created in NX8.5.0.



License requirements : None

double NXOpen::Tooling::CoolingDefineChannelBuilder::ChannelDiameter ( )

Returns the channel diameter
Created in NX7.5.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::CoolingDefineChannelBuilder::Diameter ( )

Returns the channel diameter
Created in NX10.0.0.



License requirements : None

NXOpen::Tooling::CoolingDefineChannelBuilder::ExtensionTypes NXOpen::Tooling::CoolingDefineChannelBuilder::ExtensionSolution ( )

Returns the candidate extension types
Created in NX8.5.0.



License requirements : None

NXOpen::SelectBody* NXOpen::Tooling::CoolingDefineChannelBuilder::LimitBody ( )

Returns the boundary body
Created in NX8.5.0.



License requirements : None

NXOpen::GeometricUtilities::ModlMotion* NXOpen::Tooling::CoolingDefineChannelBuilder::Motion ( )

Returns the object which defines the transformation from start point to end point.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::CoolingDefineChannelBuilder::RemoveParameter ( )

Returns the flag to indicate whether to remove parameters of the created solid or not
Created in NX12.0.0.



License requirements : None

void NXOpen::Tooling::CoolingDefineChannelBuilder::SetAdjustBoundaryChannel ( bool  adjustBoundaryChannel)

Sets the flag to indicate whether to extend boundary channel or not
Created in NX8.5.0.



License requirements : ug_mold_design ("UG MOLD")

Parameters
adjustBoundaryChanneladjustboundarychannel
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetAutoSelectBoundary ( bool  autoSelectBoundary)

Sets the value that whether the boundary body is automatically got or not
Created in NX8.5.0.



License requirements : ug_mold_design ("UG MOLD")

Parameters
autoSelectBoundaryautoselectboundary
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetBoundaryBody ( NXOpen::Body body)

Sets the boundary body to do channel extension
Created in NX8.5.0.



License requirements : None

Parameters
bodythe body set as boundary body
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetChannelDiameter ( double  channelDiameter)

Sets the channel diameter
Created in NX7.5.0.



License requirements : None

Parameters
channelDiameterchanneldiameter
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetExtensionSolution ( NXOpen::Tooling::CoolingDefineChannelBuilder::ExtensionTypes  extensionSolution)

Sets the candidate extension types
Created in NX8.5.0.



License requirements : ug_mold_design ("UG MOLD")

Parameters
extensionSolutionextensionsolution
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetRemoveParameter ( bool  removeParameter)

Sets the flag to indicate whether to remove parameters of the created solid or not
Created in NX12.0.0.



License requirements : ug_mold_design ("UG MOLD")

Parameters
removeParameterremoveparameter
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetStartPoint ( NXOpen::Point startPoint)

Sets the point as the start position of the channel.


Created in NX7.5.0.

License requirements : None

Parameters
startPointstartpoint
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetTipEndType ( NXOpen::Tooling::CoolingDefineChannelBuilder::TipEndTypes  tipEndType)

Sets the candidate of tip end type
Created in NX8.5.0.



License requirements : ug_mold_design ("UG MOLD")

Parameters
tipEndTypetipendtype
void NXOpen::Tooling::CoolingDefineChannelBuilder::SetType ( NXOpen::Tooling::CoolingDefineChannelBuilder::Types  type)

Sets the type of attributes assigned to the created body attribute type values.


Created in NX10.0.0.

License requirements : ug_mold_design ("UG MOLD")

Parameters
typetype
NXOpen::Point* NXOpen::Tooling::CoolingDefineChannelBuilder::StartPoint ( )

Returns the point as the start position of the channel.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Tooling::CoolingDefineChannelBuilder::TipAngle ( )

Returns the value for the tip angle of the channel.


Created in NX8.5.0.

License requirements : None

NXOpen::Tooling::CoolingDefineChannelBuilder::TipEndTypes NXOpen::Tooling::CoolingDefineChannelBuilder::TipEndType ( )

Returns the candidate of tip end type
Created in NX8.5.0.



License requirements : None

NXOpen::Tooling::CoolingDefineChannelBuilder::Types NXOpen::Tooling::CoolingDefineChannelBuilder::Type ( )

Returns the type of attributes assigned to the created body attribute type values.


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.