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

Creates a builder used to prepare basic design data for meshing. More...

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

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance. More...
 
double BlendRadius ()
 Returns the blend radius. More...
 
void ConvertSeamCurves (std::vector< NXOpen::Features::ShipDesign::ShipPreparationInfo * > &data)
 Converts intersection seam curves to edges on the linked bodies if found. More...
 
NXOpen::Features::ShipDesign::ShipPreparationInfoCreateBasicDesignData ()
 Creates a empty basic design data object. More...
 
void CreateUpdateDivide (NXOpen::Features::ShipDesign::ShipPreparationInfo *data)
 Creates or updates the divide feature. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
void FinalizeProcessing ()
 Cleans up all old ship preparation features, runs update and updates edge pairing. More...
 
void FindBasicDesignData (const std::vector< NXOpen::Assemblies::Component * > &components, std::vector< NXOpen::Features::ShipDesign::ShipPreparationInfo * > &data)
 Outputs the basic design data found in the given components. More...
 
void FindShipComponents (std::vector< NXOpen::Assemblies::Component * > &components, std::vector< bool > &componentsProcessed)
 Outputs the basic design components found in the loaded assembly. More...
 
NXOpen::EdgeGetPairedEdge (NXOpen::Edge *inEdge)
 Outputs the edge that is paired with the inEdge it it exists. More...
 
double HoleDiameter ()
 Returns the hole diameter. More...
 
bool RemoveBlends ()
 Returns the option to remove blends. More...
 
bool RemoveOpenings ()
 Returns the option to remove openings. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance. More...
 
void SetBlendRadius (double blendRadius)
 Sets the blend radius. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetEdgePair (NXOpen::Edge *edge1, NXOpen::Edge *edge2)
 Sets the pairing data between the two edges input. More...
 
void SetHoleDiameter (double holeDiameter)
 Sets the hole diameter. More...
 
void SetRemoveBlends (bool removeBlends)
 Sets the option to remove blends. More...
 
void SetRemoveOpenings (bool removeOpenings)
 Sets the option to remove openings. More...
 
NXOpen::Assemblies::SelectComponentListShipComponents ()
 Returns the components containing basic design data to prepare for meshing. More...
 
void UpdateEdgePairing ()
 Updates the edge pair information. More...
 
void WaveLinkBasicDesignData (NXOpen::Features::ShipDesign::ShipPreparationInfo *data)
 Wave links in the proper basic design data, if not already linked, into the work part. 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

Creates a builder used to prepare basic design data for meshing.

Multiple features are created as a result of committing this builder.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateShipPreparationBuilder
Default values.

Property Value

BlendRadius

100.0 (millimeters part), 4.0 (inches part)

HoleDiameter

300.0 (millimeters part), 12.0 (inches part)

RemoveBlends

true

RemoveOpenings

true


Created in NX10.0.0.

Member Function Documentation

double NXOpen::Features::ShipDesign::ShipPreparationBuilder::AngleTolerance ( )

Returns the angle tolerance.

Used in curve approximation.

Deprecated:
Deprecated in NX11.0.0. Removed with no replacement.


Created in NX10.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::ShipPreparationBuilder::BlendRadius ( )

Returns the blend radius.

If Features::ShipDesign::ShipPreparationBuilder::RemoveBlends and Features::ShipDesign::ShipPreparationBuilder::SetRemoveBlends is true then blends that that are less than or equal to this radius will be removed from plate systems.
Created in NX11.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::ConvertSeamCurves ( std::vector< NXOpen::Features::ShipDesign::ShipPreparationInfo * > &  data)

Converts intersection seam curves to edges on the linked bodies if found.

This method should be called after all linked plate system body features are created or updated. If any new NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedEdges preparation data is created, it is output.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
dataAdditional basic design data to be processed.
NXOpen::Features::ShipDesign::ShipPreparationInfo* NXOpen::Features::ShipDesign::ShipPreparationBuilder::CreateBasicDesignData ( )

Creates a empty basic design data object.

The caller should not delete this object.

Returns
The basic design data that was created.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::CreateUpdateDivide ( NXOpen::Features::ShipDesign::ShipPreparationInfo data)

Creates or updates the divide feature.

The basic design data is updated to contain the newly created feature if necessary.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
dataThe basic design data to create or update the divide feature.
double NXOpen::Features::ShipDesign::ShipPreparationBuilder::DistanceTolerance ( )

Returns the distance tolerance.

Used in edge pairing to determine if edges are close.
Created in NX10.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::FinalizeProcessing ( )

Cleans up all old ship preparation features, runs update and updates edge pairing.

This method should be called after all other processing is completed.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::FindBasicDesignData ( const std::vector< NXOpen::Assemblies::Component * > &  components,
std::vector< NXOpen::Features::ShipDesign::ShipPreparationInfo * > &  data 
)

Outputs the basic design data found in the given components.

First the work part is searched for any existing ship preparation data. The caller should not delete this data.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
componentsThe basic design part occurrences to find data in.
dataThe basic design data to be processed.
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::FindShipComponents ( std::vector< NXOpen::Assemblies::Component * > &  components,
std::vector< bool > &  componentsProcessed 
)

Outputs the basic design components found in the loaded assembly.


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
componentsThe basic design part occurrences.
componentsProcessedIndication if the part occurrence has already been processed.
NXOpen::Edge* NXOpen::Features::ShipDesign::ShipPreparationBuilder::GetPairedEdge ( NXOpen::Edge inEdge)

Outputs the edge that is paired with the inEdge it it exists.

This pairing information is used in the CAE application when stitching edges.

Returns
The paired edge if there is one NULL if not paired.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")
Parameters
inEdgeThe edge to get it's pair.
double NXOpen::Features::ShipDesign::ShipPreparationBuilder::HoleDiameter ( )

Returns the hole diameter.

If Features::ShipDesign::ShipPreparationBuilder::RemoveOpenings and Features::ShipDesign::ShipPreparationBuilder::SetRemoveOpenings is true then openings that fit inside a circle with this diameter will be removed from plate systems.
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipPreparationBuilder::RemoveBlends ( )

Returns the option to remove blends.

If true, blends with a radius less than or equal to Features::ShipDesign::ShipPreparationBuilder::BlendRadius and Features::ShipDesign::ShipPreparationBuilder::SetBlendRadius will be removed from plate systems.
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipPreparationBuilder::RemoveOpenings ( )

Returns the option to remove openings.

If true, openings that fit inside a circle with diameter Features::ShipDesign::ShipPreparationBuilder::HoleDiameter and Features::ShipDesign::ShipPreparationBuilder::SetHoleDiameter will be removed from plate systems.
Created in NX11.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance.

Used in curve approximation.

Deprecated:
Deprecated in NX11.0.0. Removed with no replacement.


Created in NX10.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
angleToleranceangletolerance
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetBlendRadius ( double  blendRadius)

Sets the blend radius.

If Features::ShipDesign::ShipPreparationBuilder::RemoveBlends and Features::ShipDesign::ShipPreparationBuilder::SetRemoveBlends is true then blends that that are less than or equal to this radius will be removed from plate systems.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
blendRadiusblendradius
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.

Used in edge pairing to determine if edges are close.
Created in NX10.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetEdgePair ( NXOpen::Edge edge1,
NXOpen::Edge edge2 
)

Sets the pairing data between the two edges input.

This pairing information is used in the CAE application when stitching edges.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
edge1One of the edge pairs.
edge2One of the edge pairs.
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetHoleDiameter ( double  holeDiameter)

Sets the hole diameter.

If Features::ShipDesign::ShipPreparationBuilder::RemoveOpenings and Features::ShipDesign::ShipPreparationBuilder::SetRemoveOpenings is true then openings that fit inside a circle with this diameter will be removed from plate systems.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
holeDiameterholediameter
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetRemoveBlends ( bool  removeBlends)

Sets the option to remove blends.

If true, blends with a radius less than or equal to Features::ShipDesign::ShipPreparationBuilder::BlendRadius and Features::ShipDesign::ShipPreparationBuilder::SetBlendRadius will be removed from plate systems.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
removeBlendsremoveblends
void NXOpen::Features::ShipDesign::ShipPreparationBuilder::SetRemoveOpenings ( bool  removeOpenings)

Sets the option to remove openings.

If true, openings that fit inside a circle with diameter Features::ShipDesign::ShipPreparationBuilder::HoleDiameter and Features::ShipDesign::ShipPreparationBuilder::SetHoleDiameter will be removed from plate systems.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
removeOpeningsremoveopenings
NXOpen::Assemblies::SelectComponentList* NXOpen::Features::ShipDesign::ShipPreparationBuilder::ShipComponents ( )

Returns the components containing basic design data to prepare for meshing.


Created in NX10.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::UpdateEdgePairing ( )

Updates the edge pair information.

This method should be called after all plate divide features are created or updated.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

void NXOpen::Features::ShipDesign::ShipPreparationBuilder::WaveLinkBasicDesignData ( NXOpen::Features::ShipDesign::ShipPreparationInfo data)

Wave links in the proper basic design data, if not already linked, into the work part.

The data is updated to reflect the new linked data.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
dataThe basic design data to be wave linked.

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