NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::ShipDesign::SeamBuilder Class Reference

A Features::ShipDesign::SeamBuilder used to create or edit a ship design Features::ShipDesign::Seam feature. More...

Inheritance diagram for NXOpen::Features::ShipDesign::SeamBuilder:
NXOpen::Features::ShipDesign::ProfileSystemBuilder NXOpen::Features::ShipDesign::FeatureParmsBuilder NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  DefinitionMethods { DefinitionMethodsCurvesPlanesShip, DefinitionMethodsEquallySpaced, DefinitionMethodsRectangular }
 Used to indicate the method being used to define the seam locations. More...
enum  StaggerShiftAlongMethods { StaggerShiftAlongMethodsLength, StaggerShiftAlongMethodsWidth }
 Used to indicate the method being used to define which direction the seam stagger will shift along. More...
enum  Types { TypesScantling, TypesErection, TypesStraking, TypesIntersection }
 Used to indicate the type of seam that is being created. More...

Public Member Functions

NXOpen::SectionDefinitionCurves ()
 Returns the curves selected or sketched that will be projected onto the ship structure to create the seam.
NXOpen::SectionDefinitionEquallySpacedCurve1 ()
 Returns the first curve that will be used as a boundary for the equally spaced seams.
NXOpen::SectionDefinitionEquallySpacedCurve2 ()
 Returns the second curve that will be used as a boundary for the equally spaced seams.
NXOpen::ExpressionDefinitionEquallySpacedNumber ()
 Returns the number of seams to create between the two boundary curves selected.
NXOpen::Features::ShipDesign::PlaneListBuilderListDefinitionEquallySpacedPlaneList ()
 Returns the list of planes defined that will be used to specify key points to create the seam.
NXOpen::Features::ShipDesign::SeamBuilder::DefinitionMethods DefinitionMethod ()
 Returns the method used to define the seam locations.
NXOpen::SelectNXObjectListDefinitionObjects ()
 Returns the sheet bodies or curves representing ship structure, that will be intersected with or projected onto the ship structure to create the seam.
NXOpen::Features::ShipDesign::PlaneListBuilderListDefinitionPlaneList ()
 Returns the list of planes defined that will be intersected with the ship structure to create the seam.
NXOpen::GeometricUtilities::ProjectionOptionsDefinitionProjectionDirection ()
 Returns the direction to project curves to the ship structure to define seams.
NXOpen::PointDefinitionRectangularCorner ()
 Returns the starting corner of the rectangular grid that defines the seams.
NXOpen::ExpressionDefinitionRectangularLength ()
 Returns the size of each rectangle of the grid in the length direction.
NXOpen::DirectionDefinitionRectangularLengthDirection ()
 Returns the length direction of the rectangular grid that defines the seams.
NXOpen::PlaneDefinitionRectangularPlane ()
 Returns the plane of the rectangular grid that defines the seams.
NXOpen::ExpressionDefinitionRectangularWidth ()
 Returns the size of each rectangle of the grid perpendicular to the length direction.
void SetDefinitionMethod (NXOpen::Features::ShipDesign::SeamBuilder::DefinitionMethods definitionMethod)
 Sets the method used to define the seam locations.
void SetDefinitionRectangularCorner (NXOpen::Point *definitionRectangularCorner)
 Sets the starting corner of the rectangular grid that defines the seams.
void SetDefinitionRectangularLengthDirection (NXOpen::Direction *definitionRectangularLengthDirection)
 Sets the length direction of the rectangular grid that defines the seams.
void SetDefinitionRectangularPlane (NXOpen::Plane *definitionRectangularPlane)
 Sets the plane of the rectangular grid that defines the seams.
void SetStaggerShiftAlongMethod (NXOpen::Features::ShipDesign::SeamBuilder::StaggerShiftAlongMethods staggerShiftAlongMethod)
 Sets the method used to define the seam stagger shift along method.
void SetType (NXOpen::Features::ShipDesign::SeamBuilder::Types type)
 Sets the type of seam being created.
NXOpen::SelectNXObjectListShipStructure ()
 Returns the ship structure upon which seams will be created.
NXOpen::NXObjectListStaggerDistanceList ()
 Returns the list of stagger distances defined the shift distance to create the seam.
NXOpen::Features::ShipDesign::SeamBuilder::StaggerShiftAlongMethods StaggerShiftAlongMethod ()
 Returns the method used to define the seam stagger shift along method.
NXOpen::Features::ShipDesign::SeamBuilder::Types Type ()
 Returns the type of seam being created.
NXOpen::Weld::CharacteristicsBuilderWeldingCharacteristics ()
 Returns the welding characteristics that will be attached to each seam created.

Detailed Description

A Features::ShipDesign::SeamBuilder used to create or edit a ship design Features::ShipDesign::Seam feature.


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

Property Value

DefinitionEquallySpacedNumber.Value

1

DefinitionMethod

CurvesPlanesShip

DefinitionRectangularLength.Value

20000 (millimeters part), 800 (inches part)

DefinitionRectangularWidth.Value

10000 (millimeters part), 400 (inches part)

StaggerShiftAlongMethod

Length


Created in NX8.0.0.


Member Enumeration Documentation

Used to indicate the method being used to define the seam locations.

Not valid for Features::ShipDesign::SeamBuilder::TypesIntersection .

Enumerator:
DefinitionMethodsCurvesPlanesShip 

Can use curves, planes or other ship structure to define the seam location.

The intersection or projection of the selected data with the ship structure defines the seam location.

DefinitionMethodsEquallySpaced 

Create a specified number of seams equidistant between two selected curves.

DefinitionMethodsRectangular 

Create a rectangular pattern of seams based on an origin, direction, and size of rectangles.

Used to indicate the method being used to define which direction the seam stagger will shift along.

Enumerator:
StaggerShiftAlongMethodsLength 

the stagger will shift along the length direction.

StaggerShiftAlongMethodsWidth 

the stagger will shift along the width direction.

Used to indicate the type of seam that is being created.

Enumerator:
TypesScantling 

Scantling seam, will allow for changing stock across the seam.

TypesErection 

Erection seam, used to define manufacturing block boundaries.

Will allow for changing stock across the seam.

TypesStraking 

Straking seam, used to split up structure into manufacturable size pieces.

Cannot change stock across this seam.

TypesIntersection 

Intersection seam, used to split structure at other structure locations.

Will allow for changing stock across the seam.


Member Function Documentation

Returns the curves selected or sketched that will be projected onto the ship structure to create the seam.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsCurvesPlanesShip .
Created in NX8.0.0.

License requirements : None

Returns the first curve that will be used as a boundary for the equally spaced seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsEquallySpaced .
Created in NX8.0.0.

License requirements : None

Returns the second curve that will be used as a boundary for the equally spaced seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsEquallySpaced .
Created in NX8.0.0.

License requirements : None

Returns the number of seams to create between the two boundary curves selected.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsEquallySpaced .
Created in NX8.0.0.

License requirements : None

Returns the list of planes defined that will be used to specify key points to create the seam.

Only valid when DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsEquallySpaced .
Created in NX8.0.0.

License requirements : None

Returns the method used to define the seam locations.


Created in NX8.0.0.

License requirements : None

Returns the sheet bodies or curves representing ship structure, that will be intersected with or projected onto the ship structure to create the seam.


Created in NX8.0.0.

License requirements : None

Returns the list of planes defined that will be intersected with the ship structure to create the seam.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsCurvesPlanesShip .
Created in NX8.0.0.

License requirements : None

Returns the direction to project curves to the ship structure to define seams.


Created in NX8.0.0.

License requirements : None

Returns the starting corner of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Returns the size of each rectangle of the grid in the length direction.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Returns the length direction of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Returns the plane of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Returns the size of each rectangle of the grid perpendicular to the length direction.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Sets the method used to define the seam locations.


Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
definitionMethoddefinitionmethod

Sets the starting corner of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
definitionRectangularCornerdefinitionrectangularcorner

Sets the length direction of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
definitionRectangularLengthDirectiondefinitionrectangularlengthdirection

Sets the plane of the rectangular grid that defines the seams.

Only valid when Type is not Features::ShipDesign::SeamBuilder::TypesIntersection and DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
definitionRectangularPlanedefinitionrectangularplane

Sets the method used to define the seam stagger shift along method.


Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
staggerShiftAlongMethodstaggershiftalongmethod

Sets the type of seam being created.

Scantling, Erection, Straking or Intersection. Scantling seams indicate divisions in ship structure where differing stock definitions are needed. Erection seams indicate divisions in ship structure at manufacturing block boundaries. Straking seams indicate divisions in ship structure to make it a manufacturable size. Intersection seams indicate divisions in ship structure where other structure intersects the given structure. Although Scantling seam is the name given to seams that allow for changing stock definitions, all seam types except straking seams allow for a change in the stock definition.


Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters:
typetype

Returns the ship structure upon which seams will be created.


Created in NX8.0.0.

License requirements : None

Returns the list of stagger distances defined the shift distance to create the seam.

Only valid when DefinitionMethod is Features::ShipDesign::SeamBuilder::DefinitionMethodsRectangular .
Created in NX8.0.0.

License requirements : None

Returns the method used to define the seam stagger shift along method.


Created in NX8.0.0.

License requirements : None

Returns the type of seam being created.

Scantling, Erection, Straking or Intersection. Scantling seams indicate divisions in ship structure where differing stock definitions are needed. Erection seams indicate divisions in ship structure at manufacturing block boundaries. Straking seams indicate divisions in ship structure to make it a manufacturable size. Intersection seams indicate divisions in ship structure where other structure intersects the given structure. Although Scantling seam is the name given to seams that allow for changing stock definitions, all seam types except straking seams allow for a change in the stock definition.


Created in NX8.0.0.

License requirements : None

Returns the welding characteristics that will be attached to each seam created.


Created in NX8.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.