NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::ShipDesign::EndCutBuilder Class Reference

Represents a NXOpen::Features::ShipDesign::EndCut builder. More...

Inheritance diagram for NXOpen::Features::ShipDesign::EndCutBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ConnectionTypes { ConnectionTypesConnected, ConnectionTypesFlangeFree, ConnectionTypesSniped }
 
This enum defines the different ways a limiting geometry can connect to the endcut face. More...
 
enum  DraftTypes { DraftTypesTrim, DraftTypesExtend }
 This enum defines the types of draft to be applied. More...
 
enum  LimitTypes { LimitTypesValue, LimitTypesPlane, LimitTypesNeatTrim }
 This enum defines the different ways users can trim the ends of a profile or a plate. More...
 
enum  SelectionTypes { SelectionTypesFacesWithAttributes, SelectionTypesFaceAndEdge }
 This enum defines the Placement Face and Placement Edge Selection Type. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::EndCutBuilder::ConnectionTypes ConnectionType ()
 Returns the connection type. More...
 
NXOpen::ExpressionDraftAngle ()
 Returns the draft angle
Created in NX8.0.0. More...
 
NXOpen::ExpressionDraftOffset ()
 Returns the draft offset. More...
 
NXOpen::Features::ShipDesign::EndCutBuilder::DraftTypes DraftType ()
 Returns the draft type. More...
 
NXOpen::SelectBodyFlangeBoundary ()
 Returns the flange boundary. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderFlangeSketchData ()
 Returns the flange sketch data. More...
 
void InheritParametersFromEndcutFace (NXOpen::Face *endcutFace)
 Copy the parameters from the endcut face to this endcut. More...
 
NXOpen::SelectDisplayableObjectLimitGeometry ()
 Returns the limit geometry. More...
 
NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypes LimitType ()
 Returns the limit type. More...
 
NXOpen::ExpressionOffset ()
 Returns the offset. More...
 
NXOpen::SelectEdgePlacementEdge ()
 Returns the select placement edges. More...
 
NXOpen::SelectFaceListPlacementFaces ()
 Returns the select placement faces. More...
 
NXOpen::PlanePlane ()
 Returns the plane. More...
 
NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypes SelectionType ()
 Returns the selection type. More...
 
void SetConnectionType (NXOpen::Features::ShipDesign::EndCutBuilder::ConnectionTypes connectionType)
 Sets the connection type. More...
 
void SetDraftType (NXOpen::Features::ShipDesign::EndCutBuilder::DraftTypes draftType)
 Sets the draft type. More...
 
void SetLimitType (NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypes limitType)
 Sets the limit type. More...
 
void SetPlane (NXOpen::Plane *plane)
 Sets the plane. More...
 
void SetSelectionType (NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypes selectionType)
 Sets the selection type. More...
 
NXOpen::ExpressionShearAngle ()
 Returns the shear angle. More...
 
NXOpen::ExpressionTiltAngle ()
 Returns the tilt angle
Created in NX8.0.0. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderToeSketchData ()
 Returns the toe sketch data. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderWebSketchData ()
 Returns the web sketch data. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. 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 NXOpen::Features::ShipDesign::EndCut builder.


To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateEndCutBuilder
Default values.

Property Value

ConnectionType

Connected

DraftAngle.Value

0

DraftOffset.Value

0 (millimeters part), 0 (inches part)

DraftType

Trim

LimitType

Value

Offset.Value

0 (millimeters part), 0 (inches part)

SelectionType

FacesWithAttributes

ShearAngle.Value

0

TiltAngle.Value

0


Created in NX8.0.0.

Member Enumeration Documentation


This enum defines the different ways a limiting geometry can connect to the endcut face.

This value can be used in rules to control the available section types for the flange, web or toe cuts. These values are applicable only when the Limit Type is NeatTrim.

Enumerator
ConnectionTypesConnected 

If this Connection Type is set, the offset parameter will be ignored.

ConnectionTypesFlangeFree 

If this Connection Type is set, the offset parameter will be ignored.

ConnectionTypesSniped 

If this Connection Type is set, the offset parameter can be used.

This enum defines the types of draft to be applied.

Enumerator
DraftTypesTrim 

If this Draft Type is set, the EndCut face will split and the left side face will be tapered.

DraftTypesExtend 

If this Draft Type is set, the EndCut face will split and the right side face will be tapered.

This enum defines the different ways users can trim the ends of a profile or a plate.

Enumerator
LimitTypesValue 

If this Limit Type is set, the values of Tilt Angle and Shear Angle expressions will be used.

LimitTypesPlane 

If this Limit Type is set, a Plane needs to be specified and the Tilt and Shear angles will be inferred from the intersection of Datum Plane with the body on which EndCut will be applied.

LimitTypesNeatTrim 

If this Limit Type is set, a datum plane feature, a face or a profile/plate body needs to be selected and the endcut will be trimmed to the selected geometry.

This enum defines the Placement Face and Placement Edge Selection Type.

Enumerator
SelectionTypesFacesWithAttributes 

If this Selection Type is set, just faces need to be specifed and placement edges will be inferred automatically.


All faces specified as placement faces must have valid attributes that identify it as a valid face for Endcuts.

SelectionTypesFaceAndEdge 

If this Selection Type is set, then a single pair of a Face (Placement Face) and an edge(Placement Edge) needs to be specified.

Member Function Documentation

NXOpen::Features::ShipDesign::EndCutBuilder::ConnectionTypes NXOpen::Features::ShipDesign::EndCutBuilder::ConnectionType ( )

Returns the connection type.


If the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesNeatTrim , users can define the connection type between the endcut face and the limiting geometry. Users can control the available flange, web or toe section types using the connection type in the rules.


Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::EndCutBuilder::DraftAngle ( )

Returns the draft angle
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::EndCutBuilder::DraftOffset ( )

Returns the draft offset.

This is the distance from the end of the Placement Edge where the Stiffener end face will be split.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::EndCutBuilder::DraftTypes NXOpen::Features::ShipDesign::EndCutBuilder::DraftType ( )

Returns the draft type.

A partial taper can be applied to the end face of a Stiffener. The end face will be split and the Draft Type defines which split face is tapered.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Features::ShipDesign::EndCutBuilder::FlangeBoundary ( )

Returns the flange boundary.


This input is required when the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesNeatTrim . Only a single body may be specified and it must have at least one face with MK_TYPE=MOLDINGLINE and one face with MK_TYPE=OPPOSINGMOLDINGLINE attributes. This input is applicable only when an endcut is applied to a Builtup stiffener. It will be ignored for all other cases. This input will let users define a plate or a stiffener without flange as a limit geometry and specify an edge reinforcement as a flange boundary. Users can also specify a plate as a flange boundary.


Created in NX9.0.2.

License requirements : None

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::EndCutBuilder::FlangeSketchData ( )

Returns the flange sketch data.


Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder .


Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::EndCutBuilder::InheritParametersFromEndcutFace ( NXOpen::Face endcutFace)

Copy the parameters from the endcut face to this endcut.

The input face must belong to an endcut feature and should have all the attributes. All the builder parameters will be replaced with copies of parameters from the input face. If any change is made after this call, the copied parameter value will be overwritten.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
endcutFaceendcutface
NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::EndCutBuilder::LimitGeometry ( )

Returns the limit geometry.


This input is required when the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesNeatTrim . Valid types are Plane, Face or a Body. If a Body is specified, it must have at least one face with MK_TYPE=MOLDINGLINE and one face with MK_TYPE=OPPOSINGMOLDINGLINE attributes.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypes NXOpen::Features::ShipDesign::EndCutBuilder::LimitType ( )

Returns the limit type.

The Tilt and Shear angles can be supplied as expressions or can be inferred from a Plane. Users can also limit the ends using a face or a body.


Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::EndCutBuilder::Offset ( )

Returns the offset.

The Offset is always applied after the Tilt and Shear Angles.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectEdge* NXOpen::Features::ShipDesign::EndCutBuilder::PlacementEdge ( )

Returns the select placement edges.


This input is only required when the Selection Type is NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypesFaceAndEdge . This edge must belong to the face specified as Placement Face.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectFaceList* NXOpen::Features::ShipDesign::EndCutBuilder::PlacementFaces ( )

Returns the select placement faces.


If the Selection Type is NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypesFacesWithAttributes this list can contain multiple faces and each face must be a valid endcut face, i.e. faces with SAW_SIZE and SAW_SIZE2 attributes whose value is same as the Perpendicular EndCut Name defined in the customer defaults. If the Selection Type is NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypesFaceAndEdge , this list must contain a single face. Each face will result in a separate EndCut feature. If an existing EndCut feature is queried, it will contain a single face in this list.


Created in NX8.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::EndCutBuilder::Plane ( )

Returns the plane.

If the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesPlane , the Tilt and Shear angle will be inferred automatically from this plane.
Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypes NXOpen::Features::ShipDesign::EndCutBuilder::SelectionType ( )

Returns the selection type.

Users can provide a set of faces where the edge can be inferred automatically or specify a single pair of a Face and an edge(Placement Edge).


Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::EndCutBuilder::SetConnectionType ( NXOpen::Features::ShipDesign::EndCutBuilder::ConnectionTypes  connectionType)

Sets the connection type.


If the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesNeatTrim , users can define the connection type between the endcut face and the limiting geometry. Users can control the available flange, web or toe section types using the connection type in the rules.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
connectionTypeconnectiontype
void NXOpen::Features::ShipDesign::EndCutBuilder::SetDraftType ( NXOpen::Features::ShipDesign::EndCutBuilder::DraftTypes  draftType)

Sets the draft type.

A partial taper can be applied to the end face of a Stiffener. The end face will be split and the Draft Type defines which split face is tapered.
Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
draftTypedrafttype
void NXOpen::Features::ShipDesign::EndCutBuilder::SetLimitType ( NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypes  limitType)

Sets the limit type.

The Tilt and Shear angles can be supplied as expressions or can be inferred from a Plane. Users can also limit the ends using a face or a body.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
limitTypelimittype
void NXOpen::Features::ShipDesign::EndCutBuilder::SetPlane ( NXOpen::Plane plane)

Sets the plane.

If the Limit Type is NXOpen::Features::ShipDesign::EndCutBuilder::LimitTypesPlane , the Tilt and Shear angle will be inferred automatically from this plane.
Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
planeplane
void NXOpen::Features::ShipDesign::EndCutBuilder::SetSelectionType ( NXOpen::Features::ShipDesign::EndCutBuilder::SelectionTypes  selectionType)

Sets the selection type.

Users can provide a set of faces where the edge can be inferred automatically or specify a single pair of a Face and an edge(Placement Edge).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
selectionTypeselectiontype
NXOpen::Expression* NXOpen::Features::ShipDesign::EndCutBuilder::ShearAngle ( )

Returns the shear angle.

The Shear Angle is always applied after the Tilt Angle.
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::EndCutBuilder::TiltAngle ( )

Returns the tilt angle
Created in NX8.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::EndCutBuilder::ToeSketchData ( )

Returns the toe sketch data.


Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder .


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::EndCutBuilder::WebSketchData ( )

Returns the web sketch data.


Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder .


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