This class is used to create or edit a Features::ShipDesign::Deck feature. More...

Inheritance diagram for NXOpen::Features::ShipDesign::DeckBuilder:

Public Types
enum	Types { TypesSheetBody, TypesPlanes, TypesRoundCamber, TypesStraightCamber }
	Indicates the method that is being used to define the mold face of the deck. More...

Public Types inherited from NXOpen::Features::ShipDesign::PlateSystemBuilder
enum	StiffenerDirectionType { StiffenerDirectionTypeFwdPortToInUp, StiffenerDirectionTypeAftStbdFrOutDn, StiffenerDirectionTypeFwdPortToInCtr, StiffenerDirectionTypeAftStbdFrOutCtr }
	Settings used to indicate the default primary and secondary stiffener direction. More...

Public Types inherited from NXOpen::Features::ShipDesign::FeatureParmsBuilder
enum	OrientationAngleRuleTypes { OrientationAngleRuleTypesRightHand, OrientationAngleRuleTypesShipOrientation }
	Settings to indicate how angles are to be measured. More...

Public Member Functions
NXOpen::Expression *	CamberHeight ()
	Returns the expression containing the difference in the height of the camber from the center of the ship to the hull intersections in the selected plane.

NXOpen::Expression *	CamberOffset ()
	Returns the expression containing the offset from the ends of the camber section in the selected plane to the start of the straight portion of the camber shape.

NXOpen::Expression *	CenterHeight ()
	Returns the expression containing the overall height of the camber shape at the center of the ship in the selected plane.

NXOpen::SelectBody *	Hull ()
	Returns the sheet body that defines the hull shape.

NXOpen::Plane *	MoldFacePlane ()
	Returns the plane in which the camber shape is generated.

NXOpen::Features::ShipDesign::PlaneListBuilderList *	MoldFacePlaneList ()
	Returns the list of planes defined to define the mold face.

NXOpen::SelectDatumPlaneList *	MoldFacePlanes ()
	Returns the planes selected to define the mold face.

NXOpen::SelectBody *	MoldFaceSheet ()
	Returns the sheet body selected to define the mold face.

void	SetMoldFacePlane (NXOpen::Plane *moldFacePlane)
	Sets the plane in which the camber shape is generated.

void	SetType (NXOpen::Features::ShipDesign::DeckBuilder::Types type)
	Sets the method used to define the mold face of the deck.

NXOpen::Features::ShipDesign::DeckBuilder::Types	Type ()
	Returns the method used to define the mold face of the deck.

Public Member Functions inherited from NXOpen::Features::ShipDesign::PlateSystemBuilder
NXOpen::Plane *	BoundaryPlane ()
	Returns the plane defined to indicate the boundary of the plate system.

NXOpen::Section *	BoundarySection ()
	Returns the section containing curves that define the boundary of the plate system.

NXOpen::SelectNXObjectList *	BoundarySheets ()
	Returns the sheet bodies or datum planes selected, or a face collector used to define the boundary of the plate system.

void	CleanUpTemporaryCurves ()
	Cleans up the temp curves.

NXOpen::Body *	CreateRegionBody ()
	Create the region body that has the inscribed boundaries.

void	DeletePreviewBody (bool bDelete)
	Deletes the preview body.

void	DeleteRegionBody ()
	Delete the current region body.

NXOpen::Expression *	Offset ()
	Returns the offset to apply to the selected mold face to produce the desired mold face.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	Primary ()
	Returns the primary stiffener direction.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	PrimaryOnReference ()
	Returns the primary stiffener direction when the plate system is located on a midship reference.

NXOpen::GeometricUtilities::ProjectionOptions *	ProjectionDirection ()
	Returns the direction used to project the boundary section curves onto the mold face.

NXOpen::RegionPointList *	Regions ()
	Returns the regions selected from the sheet, that has the inscribed boundaries, to keep for the final plate system shape.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	Secondary1 ()
	Returns the direction of the stiffener flange.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	Secondary1OnReference ()
	Returns the direction of the stiffener flange when the stiffener is located on a midship reference.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	Secondary2 ()
	Returns the direction of the stiffener flange.

NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType	Secondary2OnReference ()
	Returns the direction of the stiffener flange when the stiffener is located on a midship reference.

void	SetBoundaryPlane (NXOpen::Plane *boundaryPlane)
	Sets the plane defined to indicate the boundary of the plate system.

void	SetKnuckleEdges (const std::vector< NXOpen::TaggedObject * > &knuckleEdges)
	Sets the knuckle edges, which includes edges for both bend and split types.

void	SetPreviewOption (bool bPreview)
	Sets the preview option.

void	SetPrimary (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType primary)
	Sets the primary stiffener direction.

void	SetPrimaryOnReference (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType primaryOnReference)
	Sets the primary stiffener direction when the plate system is located on a midship reference.

void	SetRegionIndex (const std::vector< int > &indexArray)
	Sets the region index.

void	SetRegionPoints (const std::vector< NXOpen::Point3d > &regionPoints)
	Set the points derived from the regions of the sheet, that has the inscribed boundaries, to keep for the final plate system shape.

void	SetSecondary1 (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType secondary1)
	Sets the direction of the stiffener flange.

void	SetSecondary1OnReference (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType secondary1OnReference)
	Sets the direction of the stiffener flange when the stiffener is located on a midship reference.

void	SetSecondary2 (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType secondary2)
	Sets the direction of the stiffener flange.

void	SetSecondary2OnReference (NXOpen::Features::ShipDesign::PlateSystemBuilder::StiffenerDirectionType secondary2OnReference)
	Sets the direction of the stiffener flange when the stiffener is located on a midship reference.

void	SetSplitEdgeUpdateFlag (bool isSplitEdgeUpdate)
	Sets the flag to indicate that split knuckle edges are out of date and need to update.

void	SetTightness (int tightness)
	Sets the tightness desired for the plate system.

NXOpen::SelectNXObjectList *	SplitKnuckleEdges ()
	Returns the split knuckle edges, which are used to create seam feature to split a plate system into plate subsystem.

NXOpen::Features::ShipDesign::PlateStockBuilder *	Stock ()
	Returns the plate stock builder, used to define the plate material, grade, thickness, mass density, and thicken option.

NXOpen::Features::ShipDesign::ThicknessDirectionBuilder *	ThicknessDirection ()
	Returns the thickness direction builder, used to specify the thickness direction from the mold face.

int	Tightness ()
	Returns the tightness desired for the plate system.

NXOpen::Weld::CharacteristicsBuilder *	Weld ()
	Returns the welding characteristics builder, used to assign welding characteristics to the outermost edges of a plate system.

Public Member Functions inherited from NXOpen::Features::ShipDesign::FeatureParmsBuilder
double	AngleTolerance ()
	Returns the tolerance, in degrees, used to determine when angles are zero.

NXOpen::Features::ShipDesign::PlaneListBuilder *	CreatePlaneForList ()
	Create a Features::ShipDesign::PlaneListBuilder to add a defined plane to a list.

double	DistanceTolerance ()
	Returns the tolerance used to determine when distances are considered zero.

NXOpen::Features::ShipDesign::FeatureParmsBuilder::OrientationAngleRuleTypes	OrientationAngleRule ()
	Returns the angle rule to use when measuring angles.

void	SetAngleTolerance (double angleTolerance)
	Sets the tolerance, in degrees, used to determine when angles are zero.

void	SetDistanceTolerance (double distanceTolerance)
	Sets the tolerance used to determine when distances are considered zero.

void	SetOrientationAngleRule (NXOpen::Features::ShipDesign::FeatureParmsBuilder::OrientationAngleRuleTypes angleRule)
	Sets the angle rule to use when measuring angles.

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature.

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder.

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited.

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1.

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1.

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.

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.

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1.

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited.

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1.

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class is used to create or edit a Features::ShipDesign::Deck feature.

 <br> To create a new instance of this class, use @link Features::ShipCollection::CreateDeckBuilder  Features::ShipCollection::CreateDeckBuilder @endlink  <br>

Default values.

Property

Value

CamberHeight.Value

500 (millimeters part), 20 (inches part)

CamberOffset.Value

1000 (millimeters part), 40 (inches part)

CenterHeight.Value

6000 (millimeters part), 240 (inches part)

Offset.Value

0 (millimeters part), 0 (inches part)

Primary

FwdPortToInUp

PrimaryOnReference

FwdPortToInUp

Secondary1

FwdPortToInUp

Secondary1OnReference

FwdPortToInUp

Secondary2

FwdPortToInUp

Secondary2OnReference

FwdPortToInUp

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Features::ShipDesign::DeckBuilder::Types

Indicates the method that is being used to define the mold face of the deck.

Enumerator:

TypesSheetBody	Mold face is being defined by a selected sheet body.
TypesPlanes	Mold face is being defined by selected or defined planes.
TypesRoundCamber	Mold face is being defined by a generated round camber shape.
TypesStraightCamber	Mold face is being defined by a generated straight camber shape.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::DeckBuilder::CamberHeight ( )

Returns the expression containing the difference in the height of the camber from the center of the ship to the hull intersections in the selected plane.

Only used when type is Features::ShipDesign::DeckBuilder::TypesRoundCamber or Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::DeckBuilder::CamberOffset ( )

Returns the expression containing the offset from the ends of the camber section in the selected plane to the start of the straight portion of the camber shape.

Only used when type is Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::DeckBuilder::CenterHeight ( )

Returns the expression containing the overall height of the camber shape at the center of the ship in the selected plane.

Only used when type is Features::ShipDesign::DeckBuilder::TypesRoundCamber or Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Features::ShipDesign::DeckBuilder::Hull ( )

Returns the sheet body that defines the hull shape.

The hull shape is used to determine the ends of the camber shape section. Only used when type is Features::ShipDesign::DeckBuilder::TypesRoundCamber or Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::DeckBuilder::MoldFacePlane ( )

Returns the plane in which the camber shape is generated.

Only used when type is Features::ShipDesign::DeckBuilder::TypesRoundCamber or Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlaneListBuilderList* NXOpen::Features::ShipDesign::DeckBuilder::MoldFacePlaneList ( )

Returns the list of planes defined to define the mold face.

Each plane defined will create a deck. Only used when type is Features::ShipDesign::DeckBuilder::TypesPlanes .
Created in NX8.0.0.

License requirements : None

NXOpen::SelectDatumPlaneList* NXOpen::Features::ShipDesign::DeckBuilder::MoldFacePlanes ( )

Returns the planes selected to define the mold face.

Each plane selected will create a deck. When editing a deck, only a single plane can be selected. Only used when type is Features::ShipDesign::DeckBuilder::TypesPlanes .
Created in NX8.0.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Features::ShipDesign::DeckBuilder::MoldFaceSheet ( )

Returns the sheet body selected to define the mold face.

       Only used when type is @link Features::ShipDesign::DeckBuilder::TypesSheetBody Features::ShipDesign::DeckBuilder::TypesSheetBody@endlink .

Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::DeckBuilder::SetMoldFacePlane ( NXOpen::Plane * moldFacePlane )

Sets the plane in which the camber shape is generated.

Only used when type is Features::ShipDesign::DeckBuilder::TypesRoundCamber or Features::ShipDesign::DeckBuilder::TypesStraightCamber .
Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

moldFacePlane moldfaceplane

void NXOpen::Features::ShipDesign::DeckBuilder::SetType ( NXOpen::Features::ShipDesign::DeckBuilder::Types type )

Sets the method used to define the mold face of the deck.

Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

type type

NXOpen::Features::ShipDesign::DeckBuilder::Types NXOpen::Features::ShipDesign::DeckBuilder::Type ( )

Returns the method used to define the mold face of the deck.

Created in NX8.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Features_ShipDesign_DeckBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation