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

Represents a NXOpen::Features::ShipDesign::AlongGuideCut builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateAlongGuideCutBuilder
Default values. More...

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

Public Types

enum  CreationMethod {
  CreationMethodWeldClearance, CreationMethodWaterStop, CreationMethodEggBoxTop, CreationMethodEggBoxBottom,
  CreationMethodEggBox
}
 Creation method used to define the placement of the along guide cut. More...
 
enum  WaterStopOffsetMethod { WaterStopOffsetMethodSymmetric, WaterStopOffsetMethodAsymmetric }
 Offset option used to define the placement of the water stop guide cut. More...
 

Public Member Functions

NXOpen::ExpressionArrowHeadAngle ()
 Returns the arrow head angle when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design. More...
 
NXOpen::ExpressionArrowHeadHeight ()
 Returns the arrow head height when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design. More...
 
NXOpen::ExpressionArrowHeight ()
 Returns the arrow height when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::SelectNXObjectGuideCurve ()
 Returns the guide curve when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWeldClearance . More...
 
NXOpen::SelectNXObjectListGuideCurveList ()
 Returns the guide curve list when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWeldClearance . More...
 
NXOpen::ExpressionLeftOffsetDistance ()
 Returns the left offset distance when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethodAsymmetric , or the offset distance for both side when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethodSymmetric . More...
 
NXOpen::Features::ShipDesign::ManufacturingStockBuilderManufacturingInformation ()
 Returns the manufacturing stock builder that holds the manufacturing data. More...
 
NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod PlacementType ()
 Returns the method used to define the placement of the along guide cut
Created in NX8.5.0. More...
 
NXOpen::ExpressionRightOffsetDistance ()
 Returns the right offset distance when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethodAsymmetric . More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetPlacementType (NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod placementType)
 Sets the method used to define the placement of the along guide cut
Created in NX8.5.0. More...
 
void SetWaterStopOffsetOption (NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod offsetOption)
 Sets the offset option when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop . More...
 
NXOpen::SelectBodyListShipStructure ()
 Returns the target plate or stiffener when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWeldClearance . More...
 
NXOpen::SelectEdgeListShipStructureEdge ()
 Returns the target edge when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop . More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderSpreadsheet ()
 Returns the spreadsheet builder, NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which defines the along guide cut cross section type and parameters. More...
 
NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod WaterStopOffsetOption ()
 Returns the offset option when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop . More...
 
NXOpen::SelectNXObjectWaterStopShape ()
 Returns the tool object when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop . More...
 
NXOpen::SelectNXObjectListWaterStopShapeList ()
 Returns the tool object list when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop . 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::AlongGuideCut builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateAlongGuideCutBuilder
Default values.

Property Value

ArrowHeadAngle.Value

60.0

ArrowHeadHeight.Value

5.0 (millimeters part), 0.2 (inches part)

ArrowHeight.Value

20.0 (millimeters part), 0.8 (inches part)

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)

LeftOffsetDistance.Value

150.0 (millimeters part), 6.0 (inches part)

RightOffsetDistance.Value

150.0 (millimeters part), 6.0 (inches part)


Created in NX8.5.0.

Member Enumeration Documentation

Creation method used to define the placement of the along guide cut.

Enumerator
CreationMethodWeldClearance 

Weld clearance cut type.

CreationMethodWaterStop 

Water stop cut type.

CreationMethodEggBoxTop 

Egg box top cut type - added in NX11.

CreationMethodEggBoxBottom 

Egg box bottom cut type - added in NX11.

CreationMethodEggBox 

Only type to create basic design eggbox - added in NX12.0.

Offset option used to define the placement of the water stop guide cut.

Enumerator
WaterStopOffsetMethodSymmetric 

The left offset and right offset are symmetric.

WaterStopOffsetMethodAsymmetric 

The left offset and right offset are asymmetric.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ArrowHeadAngle ( )

Returns the arrow head angle when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design.


Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ArrowHeadHeight ( )

Returns the arrow head height when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design.


Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ArrowHeight ( )

Returns the arrow height when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodEggBox in NX ship basic design.


Created in NX12.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::AlongGuideCutBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX8.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::GuideCurve ( )
NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::GuideCurveList ( )
NXOpen::Expression* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::LeftOffsetDistance ( )
NXOpen::Features::ShipDesign::ManufacturingStockBuilder* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ManufacturingInformation ( )

Returns the manufacturing stock builder that holds the manufacturing data.


Created in NX8.5.1.

License requirements : None

NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod NXOpen::Features::ShipDesign::AlongGuideCutBuilder::PlacementType ( )

Returns the method used to define the placement of the along guide cut
Created in NX8.5.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::RightOffsetDistance ( )
void NXOpen::Features::ShipDesign::AlongGuideCutBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.


Created in NX8.5.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::ShipDesign::AlongGuideCutBuilder::SetPlacementType ( NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod  placementType)

Sets the method used to define the placement of the along guide cut
Created in NX8.5.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
placementTypeplacementtype
void NXOpen::Features::ShipDesign::AlongGuideCutBuilder::SetWaterStopOffsetOption ( NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod  offsetOption)

Sets the offset option when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWaterStop .


Created in NX8.5.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
offsetOptionoffsetoption
NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ShipStructure ( )

Returns the target plate or stiffener when the NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethod is NXOpen::Features::ShipDesign::AlongGuideCutBuilder::CreationMethodWeldClearance .


Created in NX8.5.0.

License requirements : None

NXOpen::SelectEdgeList* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::ShipStructureEdge ( )
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::Spreadsheet ( )

Returns the spreadsheet builder, NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which defines the along guide cut cross section type and parameters.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetMethod NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopOffsetOption ( )
NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopShape ( )
NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::AlongGuideCutBuilder::WaterStopShapeList ( )

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