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

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

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

Public Types

enum  CollarPlateCreationApproaches { CollarPlateCreationApproachesTemplate, CollarPlateCreationApproachesSteelFeature }
 Represents the collar plate creation approaches. More...
 
enum  Orientation { OrientationNone, OrientationNormal, OrientationFlipped }
 Represents the profile cutout orientation values. More...
 

Public Member Functions

double AngularTolerance ()
 Returns the angular tolerance (degrees). More...
 
NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CollarPlateCreationApproaches CollarPlateCreationApproach ()
 Returns. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderCutoutData ()
 Returns the sketch controlling the shape and parameters of the profile cutout. More...
 
double DistanceTolerance ()
 Returns the distance tolerance (part units). More...
 
bool EnableCollarPlate ()
 Returns the flag to enable collar plate creation when creating profile cutout. More...
 
bool EnableCornerCut ()
 Returns the flag to enable corner cut creation when creating profile cutout. More...
 
void EvaluateProfileCutoutParameters (NXOpen::TaggedObject *tgTargetBody, NXOpen::TaggedObject *tgProfileBody)
 Updates the parameters in profile cutout builder using parameters rules. More...
 
NXOpen::Features::ShipDesign::ProfileCutoutBuilder::Orientation FindOrientation ()
 This method will find out the profile cutout orientation. More...
 
NXOpen::Features::ShipDesign::ManufacturingStockBuilderManufacturingInformation ()
 Returns the manufacturing stock builder that holds the manufacturing data. More...
 
NXOpen::Features::ShipDesign::ManufacturingStockBuilderManufacturingStock ()
 Returns the manufacturing stock builder that holds the manufacturing data. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderMoldingSideScallop ()
 Returns the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which holds the information of the molding side scallop. More...
 
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderOpposingSideScallop ()
 Returns the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which holds the information of the opposing molding side scallop. More...
 
bool ParametersInUserControl ()
 Returns the flag to indicate if the profile cutout detail parameters have been modified by user. More...
 
NXOpen::SelectDisplayableObjectListProfileBodies ()
 Returns the profiles that are to have a cutout created for them. More...
 
void RemoveSlaves ()
 Temporarily removes profile cutout slave features when editing profile cutout in ship basic design to prevent the downstream features from updating. More...
 
void ResetContextEntity (NXOpen::TaggedObject *tgTargetBody, NXOpen::TaggedObject *tgProfileBody)
 Resets the section types acoording to the tightness attribute on the target and the context attribute on the profile
Created in NX10.0.0. More...
 
bool SectionTypesInUserControl ()
 Returns the flag to indicate if the section types have been modified by user. More...
 
void SetAngularTolerance (double angularTolerance)
 Sets the angular tolerance (degrees). More...
 
void SetCollarPlateCreationApproach (NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CollarPlateCreationApproaches collarPlateCreationApproach)
 Sets. More...
 
void SetDefaultScallopTypes (const NXString &strProfileCutoutType)
 Set the default scallop types for the profile cutout builder. More...
 
void SetDefaultScallopTypes (const char *strProfileCutoutType)
 Set the default scallop types for the profile cutout builder. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance (part units). More...
 
void SetEnableCollarPlate (bool enableCollarPlate)
 Sets the flag to enable collar plate creation when creating profile cutout. More...
 
void SetEnableCornerCut (bool bEnableCornerCut)
 Sets the flag to enable corner cut creation when creating profile cutout. More...
 
void SetParametersInUserControl (bool bIsParametersInUserControl)
 Sets the flag to indicate if the profile cutout detail parameters have been modified by user. More...
 
void SetSectionTypesInUserControl (bool bIsSectionTypesInUserControl)
 Sets the flag to indicate if the section types have been modified by user. More...
 
void SynchronizeParametersWithProfileBody (NXOpen::TaggedObject *tgProfileBody)
 Updates the parameters in profile cutout builder using profile body. More...
 
NXOpen::SelectDisplayableObjectListTargetObjects ()
 Returns the plates that are to have cutouts placed into them for each profile. More...
 
NXOpen::Weld::CharacteristicsBuilderWeldCharacteristics ()
 Returns the welding characteristics that will be attached to profile cuotut edges which have attribute MK_TYPE=WELD_EDGE. 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::ProfileCutout builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateProfileCutoutBuilder
Default values.

Property Value

AngularTolerance

0.5

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)


Created in NX8.0.0.

Member Enumeration Documentation

Represents the collar plate creation approaches.

Enumerator
CollarPlateCreationApproachesTemplate 

Template approach - Use Standard Part Framework to create collar plate.

CollarPlateCreationApproachesSteelFeature 

Steel feature approach - User Collar Plate to create collar plate.

Represents the profile cutout orientation values.

Enumerator
OrientationNone 

no set

OrientationNormal 

normal

OrientationFlipped 

flipped

Member Function Documentation

double NXOpen::Features::ShipDesign::ProfileCutoutBuilder::AngularTolerance ( )

Returns the angular tolerance (degrees).


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CollarPlateCreationApproaches NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CollarPlateCreationApproach ( )

Returns.

the approach to be used in creating collar plate.


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CutoutData ( )

Returns the sketch controlling the shape and parameters of the profile cutout.


The cutout sketch type and its parameters are controlled by the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder .


Created in NX8.0.0.

License requirements : None

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

Returns the distance tolerance (part units).


Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ProfileCutoutBuilder::EnableCollarPlate ( )

Returns the flag to enable collar plate creation when creating profile cutout.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ProfileCutoutBuilder::EnableCornerCut ( )

Returns the flag to enable corner cut creation when creating profile cutout.


Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::EvaluateProfileCutoutParameters ( NXOpen::TaggedObject tgTargetBody,
NXOpen::TaggedObject tgProfileBody 
)

Updates the parameters in profile cutout builder using parameters rules.


Created in NX10.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
tgTargetBodytgtargetbody
tgProfileBodytgprofilebody
NXOpen::Features::ShipDesign::ProfileCutoutBuilder::Orientation NXOpen::Features::ShipDesign::ProfileCutoutBuilder::FindOrientation ( )

This method will find out the profile cutout orientation.

This information will be used for drawing automation to draw the profile cutout symbol, when the profile cutout was created by flip then the symbol should be drawn flip also. So this method can be used to indicate whether the profile cuotut was created by flip or not. The logic is: The target plate shuold have the start/end flag(by seeing the End cut face attributes) and the profile(profile cutout created based on)'s molding line face is more nearing to the start of the plate, then this method will return Normal, or Flipped. if the targe plate doens't have any flag of start/end, then None will be returned.

Returns

Created in NX8.5.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
NXOpen::Features::ShipDesign::ManufacturingStockBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ManufacturingInformation ( )

Returns the manufacturing stock builder that holds the manufacturing data.


Created in NX8.5.1.

License requirements : None

NXOpen::Features::ShipDesign::ManufacturingStockBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ManufacturingStock ( )

Returns the manufacturing stock builder that holds the manufacturing data.


Deprecated:
Deprecated in NX8.5.1. Use NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ManufacturingInformation instead.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::MoldingSideScallop ( )

Returns the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which holds the information of the molding side scallop.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::OpposingSideScallop ( )

Returns the NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder , which holds the information of the opposing molding side scallop.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ParametersInUserControl ( )

Returns the flag to indicate if the profile cutout detail parameters have been modified by user.

If it is true, it means the parameter values are specified by user and the rule driven process will not update the parameter values.
Created in NX9.0.1.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ProfileBodies ( )

Returns the profiles that are to have a cutout created for them.


Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::RemoveSlaves ( )

Temporarily removes profile cutout slave features when editing profile cutout in ship basic design to prevent the downstream features from updating.

They will be restrored when committing the profile cutout builder.
Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::ResetContextEntity ( NXOpen::TaggedObject tgTargetBody,
NXOpen::TaggedObject tgProfileBody 
)

Resets the section types acoording to the tightness attribute on the target and the context attribute on the profile
Created in NX10.0.0.



License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
tgTargetBodytgtargetbody
tgProfileBodytgprofilebody
bool NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SectionTypesInUserControl ( )

Returns the flag to indicate if the section types have been modified by user.

If it is true, it means the section type is chosen by user and the rule driven process will not update the type.
Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetAngularTolerance ( double  angularTolerance)

Sets the angular tolerance (degrees).


Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
angularToleranceangulartolerance
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetCollarPlateCreationApproach ( NXOpen::Features::ShipDesign::ProfileCutoutBuilder::CollarPlateCreationApproaches  collarPlateCreationApproach)

Sets.

the approach to be used in creating collar plate.


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
collarPlateCreationApproachcollarplatecreationapproach
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetDefaultScallopTypes ( const NXString strProfileCutoutType)

Set the default scallop types for the profile cutout builder.


Created in NX9.0.0.

License requirements : None

Parameters
strProfileCutoutTypestrprofilecutouttype
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetDefaultScallopTypes ( const char *  strProfileCutoutType)

Set the default scallop types for the profile cutout builder.


Created in NX9.0.0.

License requirements : None

Parameters
strProfileCutoutTypestrprofilecutouttype
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance (part units).


Created in NX8.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetEnableCollarPlate ( bool  enableCollarPlate)

Sets the flag to enable collar plate creation when creating profile cutout.


Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
enableCollarPlateenablecollarplate
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetEnableCornerCut ( bool  bEnableCornerCut)

Sets the flag to enable corner cut creation when creating profile cutout.


Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
bEnableCornerCutbenablecornercut
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetParametersInUserControl ( bool  bIsParametersInUserControl)

Sets the flag to indicate if the profile cutout detail parameters have been modified by user.

If it is true, it means the parameter values are specified by user and the rule driven process will not update the parameter values.
Created in NX9.0.1.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
bIsParametersInUserControlbisparametersinusercontrol
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SetSectionTypesInUserControl ( bool  bIsSectionTypesInUserControl)

Sets the flag to indicate if the section types have been modified by user.

If it is true, it means the section type is chosen by user and the rule driven process will not update the type.
Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
bIsSectionTypesInUserControlbissectiontypesinusercontrol
void NXOpen::Features::ShipDesign::ProfileCutoutBuilder::SynchronizeParametersWithProfileBody ( NXOpen::TaggedObject tgProfileBody)

Updates the parameters in profile cutout builder using profile body.


Created in NX10.0.3.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
tgProfileBodytgprofilebody
NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::TargetObjects ( )

Returns the plates that are to have cutouts placed into them for each profile.


Created in NX8.0.0.

License requirements : None

NXOpen::Weld::CharacteristicsBuilder* NXOpen::Features::ShipDesign::ProfileCutoutBuilder::WeldCharacteristics ( )

Returns the welding characteristics that will be attached to profile cuotut edges which have attribute MK_TYPE=WELD_EDGE.


Created in NX9.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.