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

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

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

Public Types

enum  BodyTypes { BodyTypesSheetBody, BodyTypesSolidBody }
 Settings to indicate the plate output body type. More...
 
enum  RegionOptions { RegionOptionsAll, RegionOptionsInsideBody, RegionOptionsOutsideBody }
 Settings to indicate what areas to create the plate when using body faces as boundaries. More...
 
enum  TightnessOptions { TightnessOptionsNonTight, TightnessOptionsWaterTight, TightnessOptionsOilTight, TightnessOptionsAirTight }
 Settings to indicate what tightness to create the plate. More...
 
enum  Types { TypesCreate, TypesAdopt }
 Settings to indicate how the plate is generated. More...
 

Public Member Functions

void AddMergeRegionPoint (const NXOpen::Point3d &regionPoint)
 Adds a merge region point. More...
 
void AddRegionPoint (const NXOpen::Point3d &regionPoint)
 Adds a region point. More...
 
NXOpen::SelectBodyListAdoptionBodies ()
 Returns the adoption bodies, which are used to create multiple plates. More...
 
NXOpen::ScCollectorAdoptionBodiesMoldFace ()
 Returns the mold face of adoption bodies. More...
 
NXOpen::SelectBodyListBodyBoundary ()
 Returns the body boundary, which can be mixed with curve, face and plane to define the plate boundary. More...
 
NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilderCreatePlateBoundaryOptionBuilder ()
 Creates a NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder. More...
 
std::vector< NXOpen::Body * > CreateRegions ()
 Creates regions to output the selected plates. More...
 
NXOpen::SectionCurveBoundary ()
 Returns the curve boundary, which can be a single region or multiple regions. More...
 
void DeleteRegions ()
 Deletes regions
Created in NX8.0.0. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::ExpressionCollectorSetListFacePlaneBoundary ()
 Returns the face, plane boundary, which defines a list of trimming objects with offset values. More...
 
bool FlipDirection ()
 Returns the flip direction, which can change the plate thickness direction. More...
 
std::vector< NXOpen::Point3dGetMultipleRegionPoints ()
 Gets multiple region points. More...
 
NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder::TrimTypes GetPlateBoundaryTrimType (int nItem)
 Gets plate boundary trim type. More...
 
bool GetShowMigratedBody ()
 Gets the show migrated body flag. More...
 
void MapRegionToRegionPoint (const NXString &plateRegionString, const NXOpen::Point3d &regionPoint)
 Maps the user selected plate region to a region point. More...
 
void MapRegionToRegionPoint (const char *plateRegionString, const NXOpen::Point3d &regionPoint)
 Maps the user selected plate region to a region point. More...
 
NXOpen::SelectBodyListMergeRegions ()
 Returns the multiple regions to merge together as plate body. More...
 
NXOpen::ScCollectorMoldFace ()
 Returns the mold face, which is used to create the plate body and define the plate placement. More...
 
NXOpen::ExpressionMoldFaceOffset ()
 Returns the mold face offset, which defines an offset distance to the mold face. More...
 
NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilderListPlateBoundaryOptionList ()
 Returns the build boundary option builder list
Created in NX11.0.0. More...
 
NXOpen::Features::ShipDesign::PlateStockBuilderPlateStock ()
 Returns the plate stock builder, which defines the plate material, grade, thickness, mass density, thicken option and opposite thickness. More...
 
NXOpen::GeometricUtilities::ProjectionOptionsProjectDirection ()
 Returns the project direction, which is used to project the boundary curves to the plate mold face. More...
 
NXOpen::Features::ShipDesign::PlateBuilder::RegionOptions RegionOption ()
 Returns the region option, which defines the plate areas in case of body faces as plate boundary. More...
 
NXOpen::Point3d RegionPoint ()
 Returns the region point, which is used to identify the plate region. More...
 
NXOpen::SelectNXObjectListRegions ()
 Returns the regions to create plates
Created in NX8.0.0. More...
 
void RemoveAllRegionPoints ()
 Removes all region points. More...
 
void RemoveMergeRegionPoint (const NXOpen::Point3d &regionPoint)
 Removes a merge region point. More...
 
void RemoveRegionPoint (const NXOpen::Point3d &regionPoint)
 Removes a region point. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetFlipDirection (bool flipDirection)
 Sets the flip direction, which can change the plate thickness direction. More...
 
void SetKnuckleEdges (const std::vector< NXOpen::Edge * > &knuckleEdges)
 Sets the knuckle edges, which include edges for both bend and split types. More...
 
void SetPlateBoundaryTrimType (int nItem, NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder::TrimTypes type)
 Sets plate boundary trim type
Created in NX11.0.0. More...
 
void SetRegionOption (NXOpen::Features::ShipDesign::PlateBuilder::RegionOptions regionOption)
 Sets the region option, which defines the plate areas in case of body faces as plate boundary. More...
 
void SetRegionPoint (const NXOpen::Point3d &regionPoint)
 Sets the region point, which is used to identify the plate region. More...
 
void SetShowMigratedBody (bool showMigratedBody)
 Sets the show migrated body flag. More...
 
void SetTightness (NXOpen::Features::ShipDesign::PlateBuilder::TightnessOptions tightness)
 Sets the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight. More...
 
void SetType (NXOpen::Features::ShipDesign::PlateBuilder::Types type)
 Sets the plate type, which is creation or adoption. More...
 
NXOpen::Features::ShipDesign::ShipNamesBuilderShipNames ()
 Returns. More...
 
NXOpen::SelectEdgeListSplitKnuckleEdges ()
 Returns the split knuckle edges, which are used to split a plate into separate knuckle parts. More...
 
NXOpen::Features::ShipDesign::PlateBuilder::TightnessOptions Tightness ()
 Returns the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight. More...
 
NXOpen::Features::ShipDesign::PlateBuilder::Types Type ()
 Returns the plate type, which is creation or adoption. 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::Plate builder.

This builder is used to create and edit ship plate feature. The plate feature can be created from construction curves, boundary faces or planes. And also a solid body cab be adopted as a plate.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreatePlateBuilder
Default values.

Property Value

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)

MoldFaceOffset.Value

0 (millimeters part), 0 (inches part)

PlateStock.KnuckleRatio

3.0

PlateStock.KnuckleSmoothAngle

3.0

PlateStock.MaterialOption

0

PlateStock.OppositeThickness.Value

0 (millimeters part), 0 (inches part)

PlateStock.RestrictThicknessToMaterial

true

PlateStock.ThickenOption

SingleSided

PlateStock.Thickness.Value

10 (millimeters part), 0.5 (inches part)

PlateStock.ThicknessSourceOption

List

RegionOption

OutsideBody

Tightness

NonTight


Created in NX8.0.0.

Member Enumeration Documentation

Settings to indicate the plate output body type.

Enumerator
BodyTypesSheetBody 

Outputs a plate as a sheet body.

BodyTypesSolidBody 

Outputs a plate as a solid body.

Settings to indicate what areas to create the plate when using body faces as boundaries.

Enumerator
RegionOptionsAll 

all

RegionOptionsInsideBody 

inside body

RegionOptionsOutsideBody 

outside body

Settings to indicate what tightness to create the plate.

Enumerator
TightnessOptionsNonTight 

non tight

TightnessOptionsWaterTight 

water tight

TightnessOptionsOilTight 

oil tight

TightnessOptionsAirTight 

air tight

Settings to indicate how the plate is generated.

Enumerator
TypesCreate 

Creates plate body.

TypesAdopt 

Adopts plate body.

Member Function Documentation

void NXOpen::Features::ShipDesign::PlateBuilder::AddMergeRegionPoint ( const NXOpen::Point3d regionPoint)

Adds a merge region point.

If there are multiple region points, do a loop to add one by one.
Created in NX12.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionPointregionpoint
void NXOpen::Features::ShipDesign::PlateBuilder::AddRegionPoint ( const NXOpen::Point3d regionPoint)

Adds a region point.

If there are multiple region points, do a loop to add one by one.
Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionPointregionpoint
NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::PlateBuilder::AdoptionBodies ( )

Returns the adoption bodies, which are used to create multiple plates.

Each plate has a single body.
Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::PlateBuilder::AdoptionBodiesMoldFace ( )

Returns the mold face of adoption bodies.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::PlateBuilder::BodyBoundary ( )

Returns the body boundary, which can be mixed with curve, face and plane to define the plate boundary.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder* NXOpen::Features::ShipDesign::PlateBuilder::CreatePlateBoundaryOptionBuilder ( )

Creates a NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder.

Returns

Created in NX11.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")
std::vector<NXOpen::Body *> NXOpen::Features::ShipDesign::PlateBuilder::CreateRegions ( )

Creates regions to output the selected plates.

Returns
Region Bodies
Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")
NXOpen::Section* NXOpen::Features::ShipDesign::PlateBuilder::CurveBoundary ( )

Returns the curve boundary, which can be a single region or multiple regions.

In case of multiple regions, it creates multiple plates.
Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::PlateBuilder::DeleteRegions ( )

Deletes regions
Created in NX8.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

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

Returns the distance tolerance.


Created in NX8.0.0.

License requirements : None

NXOpen::ExpressionCollectorSetList* NXOpen::Features::ShipDesign::PlateBuilder::FacePlaneBoundary ( )

Returns the face, plane boundary, which defines a list of trimming objects with offset values.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::PlateBuilder::FlipDirection ( )

Returns the flip direction, which can change the plate thickness direction.


Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::Point3d> NXOpen::Features::ShipDesign::PlateBuilder::GetMultipleRegionPoints ( )

Gets multiple region points.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder::TrimTypes NXOpen::Features::ShipDesign::PlateBuilder::GetPlateBoundaryTrimType ( int  nItem)

Gets plate boundary trim type.

Returns

Created in NX11.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")
Parameters
nItemnitem
bool NXOpen::Features::ShipDesign::PlateBuilder::GetShowMigratedBody ( )

Gets the show migrated body flag.

Reserved for administrator use only.

Returns

Created in NX8.5.3.

License requirements : None
void NXOpen::Features::ShipDesign::PlateBuilder::MapRegionToRegionPoint ( const NXString plateRegionString,
const NXOpen::Point3d regionPoint 
)

Maps the user selected plate region to a region point.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
plateRegionStringplateregionstring
regionPointregionpoint
void NXOpen::Features::ShipDesign::PlateBuilder::MapRegionToRegionPoint ( const char *  plateRegionString,
const NXOpen::Point3d regionPoint 
)

Maps the user selected plate region to a region point.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
plateRegionStringplateregionstring
regionPointregionpoint
NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::PlateBuilder::MergeRegions ( )

Returns the multiple regions to merge together as plate body.


Created in NX12.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::PlateBuilder::MoldFace ( )

Returns the mold face, which is used to create the plate body and define the plate placement.


Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::PlateBuilder::MoldFaceOffset ( )

Returns the mold face offset, which defines an offset distance to the mold face.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilderList* NXOpen::Features::ShipDesign::PlateBuilder::PlateBoundaryOptionList ( )

Returns the build boundary option builder list
Created in NX11.0.0.



License requirements : None

NXOpen::Features::ShipDesign::PlateStockBuilder* NXOpen::Features::ShipDesign::PlateBuilder::PlateStock ( )

Returns the plate stock builder, which defines the plate material, grade, thickness, mass density, thicken option and opposite thickness.


Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::ProjectionOptions* NXOpen::Features::ShipDesign::PlateBuilder::ProjectDirection ( )

Returns the project direction, which is used to project the boundary curves to the plate mold face.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlateBuilder::RegionOptions NXOpen::Features::ShipDesign::PlateBuilder::RegionOption ( )

Returns the region option, which defines the plate areas in case of body faces as plate boundary.


Created in NX8.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Features::ShipDesign::PlateBuilder::RegionPoint ( )

Returns the region point, which is used to identify the plate region.


Created in NX9.0.3.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::PlateBuilder::Regions ( )

Returns the regions to create plates
Created in NX8.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::PlateBuilder::RemoveAllRegionPoints ( )

Removes all region points.


Created in NX10.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::PlateBuilder::RemoveMergeRegionPoint ( const NXOpen::Point3d regionPoint)

Removes a merge region point.


Created in NX12.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionPointregionpoint
void NXOpen::Features::ShipDesign::PlateBuilder::RemoveRegionPoint ( const NXOpen::Point3d regionPoint)

Removes a region point.

Plate will find the region body by the input region point and remove the cached region point.
Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionPointregionpoint
void NXOpen::Features::ShipDesign::PlateBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::ShipDesign::PlateBuilder::SetFlipDirection ( bool  flipDirection)

Sets the flip direction, which can change the plate thickness direction.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
flipDirectionflipdirection
void NXOpen::Features::ShipDesign::PlateBuilder::SetKnuckleEdges ( const std::vector< NXOpen::Edge * > &  knuckleEdges)

Sets the knuckle edges, which include edges for both bend and split types.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
knuckleEdgesG0 edges
void NXOpen::Features::ShipDesign::PlateBuilder::SetPlateBoundaryTrimType ( int  nItem,
NXOpen::Features::ShipDesign::PlateBoundaryOptionBuilder::TrimTypes  type 
)

Sets plate boundary trim type
Created in NX11.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
nItemnitem
typetype
void NXOpen::Features::ShipDesign::PlateBuilder::SetRegionOption ( NXOpen::Features::ShipDesign::PlateBuilder::RegionOptions  regionOption)

Sets the region option, which defines the plate areas in case of body faces as plate boundary.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionOptionregionoption
void NXOpen::Features::ShipDesign::PlateBuilder::SetRegionPoint ( const NXOpen::Point3d regionPoint)

Sets the region point, which is used to identify the plate region.


Created in NX9.0.3.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
regionPointregionpoint
void NXOpen::Features::ShipDesign::PlateBuilder::SetShowMigratedBody ( bool  showMigratedBody)

Sets the show migrated body flag.

Reserved for administrator use only.
Created in NX8.5.3.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
showMigratedBodyshowmigratedbody
void NXOpen::Features::ShipDesign::PlateBuilder::SetTightness ( NXOpen::Features::ShipDesign::PlateBuilder::TightnessOptions  tightness)

Sets the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
tightnesstightness
void NXOpen::Features::ShipDesign::PlateBuilder::SetType ( NXOpen::Features::ShipDesign::PlateBuilder::Types  type)

Sets the plate type, which is creation or adoption.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
typetype
NXOpen::Features::ShipDesign::ShipNamesBuilder* NXOpen::Features::ShipDesign::PlateBuilder::ShipNames ( )

Returns.

The ship name builder.

The ship name builder is used to construct the part name of the structure.


Created in NX11.0.0.

License requirements : None

NXOpen::SelectEdgeList* NXOpen::Features::ShipDesign::PlateBuilder::SplitKnuckleEdges ( )

Returns the split knuckle edges, which are used to split a plate into separate knuckle parts.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlateBuilder::TightnessOptions NXOpen::Features::ShipDesign::PlateBuilder::Tightness ( )

Returns the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight.


Created in NX9.0.0.

License requirements : None

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

Returns the plate type, which is creation or adoption.


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.