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

This builder allows you to define the stock information for plate system features in ship design. More...

Inheritance diagram for NXOpen::Features::ShipDesign::PlateStockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ThickenOptions { ThickenOptionsSingleSided, ThickenOptionsTwoSided, ThickenOptionsSymmetric }
 Settings to indicate how to apply the thickness to the mold face or offset mold face . More...
 
enum  ThicknessSourceOptions { ThicknessSourceOptionsFile, ThicknessSourceOptionsList }
 Settings to indicate where the material thickness source resides. More...
 

Public Member Functions

double KnuckleRatio ()
 Returns the knuckle ratio, which is used to calcuate the knuckle bend radius by multiplying the plate thickness by the ratio. More...
 
double KnuckleSmoothAngle ()
 Returns the knuckle smooth angle, which is used to determine whether a edge is knuckle edge or not. More...
 
NXOpen::ExpressionMassDensity ()
 Returns the material mass density. More...
 
NXString MaterialGradeName ()
 Returns the material grade name. More...
 
int MaterialGradeOption ()
 Returns the material grade option. More...
 
NXString MaterialName ()
 Returns the material name. More...
 
int MaterialOption ()
 Returns the material option. More...
 
NXOpen::ExpressionOppositeThickness ()
 Returns the opposite thickness. More...
 
bool RestrictThicknessToMaterial ()
 Returns the flag that indicates if thickness specification should be restricted to that defined in the material data base. More...
 
void SetKnuckleRatio (double knuckleRatio)
 Sets the knuckle ratio, which is used to calcuate the knuckle bend radius by multiplying the plate thickness by the ratio. More...
 
void SetKnuckleSmoothAngle (double knuckleSmoothAngle)
 Sets the knuckle smooth angle, which is used to determine whether a edge is knuckle edge or not. More...
 
void SetMaterialGradeName (const NXString &materiaGradelName)
 Sets the material grade name. More...
 
void SetMaterialGradeName (const char *materiaGradelName)
 Sets the material grade name. More...
 
void SetMaterialGradeOption (int materialGradeOption)
 Sets the material grade option. More...
 
void SetMaterialName (const NXString &materialName)
 Sets the material name. More...
 
void SetMaterialName (const char *materialName)
 Sets the material name. More...
 
void SetMaterialOption (int materialOption)
 Sets the material option. More...
 
void SetRestrictThicknessToMaterial (bool restrictThicknessToMaterial)
 Sets the flag that indicates if thickness specification should be restricted to that defined in the material data base. More...
 
void SetThickenOption (NXOpen::Features::ShipDesign::PlateStockBuilder::ThickenOptions thickenOption)
 Sets the thicken option. More...
 
void SetThicknessOption (int thicknessOption)
 Sets the thickness option. More...
 
void SetThicknessSourceOption (NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessSourceOptions thicknessSourceOption)
 Sets the thickness source option. More...
 
void SetThicknessStr (const NXString &thicknessStr)
 Sets the thickness in string format. More...
 
void SetThicknessStr (const char *thicknessStr)
 Sets the thickness in string format. More...
 
void SetWeightRating (const NXString &weightRating)
 Sets the weight rating, which is defined together with material data and has one to one relationship to the thickness. More...
 
void SetWeightRating (const char *weightRating)
 Sets the weight rating, which is defined together with material data and has one to one relationship to the thickness. More...
 
NXOpen::Features::ShipDesign::PlateStockBuilder::ThickenOptions ThickenOption ()
 Returns the thicken option. More...
 
NXOpen::ExpressionThickness ()
 Returns the thickness. More...
 
int ThicknessOption ()
 Returns the thickness option. More...
 
NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessSourceOptions ThicknessSourceOption ()
 Returns the thickness source option. More...
 
NXString ThicknessStr ()
 Returns the thickness in string format. More...
 
NXString WeightRating ()
 Returns the weight rating, which is defined together with material data and has one to one relationship to the thickness. 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

This builder allows you to define the stock information for plate system features in ship design.

It represents NXOpen::Features::ShipDesign::PlateStockBuilder
This class is sub-object of another builder, and cannot be directly instantiated.
Default values.

Property Value

KnuckleRatio

3.0

KnuckleSmoothAngle

3.0

MaterialOption

0

OppositeThickness.Value

0 (millimeters part), 0 (inches part)

RestrictThicknessToMaterial

true

ThickenOption

SingleSided

Thickness.Value

10 (millimeters part), 0.5 (inches part)

ThicknessSourceOption

List


Created in NX8.0.0.

Member Enumeration Documentation

Settings to indicate how to apply the thickness to the mold face or offset mold face .

The front side of the offset mold face is defined by the client class using NXOpen::Features::ShipDesign::PlateStockBuilder .

Enumerator
ThickenOptionsSingleSided 

Thickness is applied to only the front side of the offset mold face.

ThickenOptionsTwoSided 

The opposite thickness is applied to the back side of the offset mold face, thickness minus the opposite thickness is applied to the front side of the offset mold face.

ThickenOptionsSymmetric 

Half of the thickness is applied to back and front sides of the offset mold face.

Settings to indicate where the material thickness source resides.

Enumerator
ThicknessSourceOptionsFile 

The thickness is defined by a table of standard thicknesses for different material and material grades in CSV file.

ThicknessSourceOptionsList 

The thickness is defined by a list of standard thicknesses for different material and material grades.

Member Function Documentation

double NXOpen::Features::ShipDesign::PlateStockBuilder::KnuckleRatio ( )

Returns the knuckle ratio, which is used to calcuate the knuckle bend radius by multiplying the plate thickness by the ratio.


Created in NX9.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::PlateStockBuilder::KnuckleSmoothAngle ( )

Returns the knuckle smooth angle, which is used to determine whether a edge is knuckle edge or not.


Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::PlateStockBuilder::MassDensity ( )

Returns the material mass density.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::PlateStockBuilder::MaterialGradeName ( )

Returns the material grade name.


Created in NX8.0.0.

License requirements : None

int NXOpen::Features::ShipDesign::PlateStockBuilder::MaterialGradeOption ( )

Returns the material grade option.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::PlateStockBuilder::MaterialName ( )

Returns the material name.


Created in NX8.0.0.

License requirements : None

int NXOpen::Features::ShipDesign::PlateStockBuilder::MaterialOption ( )

Returns the material option.


Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::PlateStockBuilder::OppositeThickness ( )

Returns the opposite thickness.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::PlateStockBuilder::RestrictThicknessToMaterial ( )

Returns the flag that indicates if thickness specification should be restricted to that defined in the material data base.

true indicates it should be restricted, false indicates it is not restricted.


Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::PlateStockBuilder::SetKnuckleRatio ( double  knuckleRatio)

Sets the knuckle ratio, which is used to calcuate the knuckle bend radius by multiplying the plate thickness by the ratio.


Created in NX9.0.0.

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

Parameters
knuckleRatioknuckleratio
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetKnuckleSmoothAngle ( double  knuckleSmoothAngle)

Sets the knuckle smooth angle, which is used to determine whether a edge is knuckle edge or not.


Created in NX9.0.0.

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

Parameters
knuckleSmoothAngleknucklesmoothangle
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialGradeName ( const NXString materiaGradelName)

Sets the material grade name.


Created in NX8.0.0.

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

Parameters
materiaGradelNamemateriagradelname
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialGradeName ( const char *  materiaGradelName)

Sets the material grade name.


Created in NX8.0.0.

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

Parameters
materiaGradelNamemateriagradelname
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialGradeOption ( int  materialGradeOption)

Sets the material grade option.


Created in NX8.0.0.

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

Parameters
materialGradeOptionmaterialgradeoption
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialName ( const NXString materialName)

Sets the material name.


Created in NX8.0.0.

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

Parameters
materialNamematerialname
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialName ( const char *  materialName)

Sets the material name.


Created in NX8.0.0.

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

Parameters
materialNamematerialname
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetMaterialOption ( int  materialOption)

Sets the material option.


Created in NX8.0.0.

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

Parameters
materialOptionmaterialoption
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetRestrictThicknessToMaterial ( bool  restrictThicknessToMaterial)

Sets the flag that indicates if thickness specification should be restricted to that defined in the material data base.

true indicates it should be restricted, false indicates it is not restricted.


Created in NX8.0.0.

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

Parameters
restrictThicknessToMaterialrestrictthicknesstomaterial
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetThickenOption ( NXOpen::Features::ShipDesign::PlateStockBuilder::ThickenOptions  thickenOption)

Sets the thicken option.


Created in NX8.0.0.

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

Parameters
thickenOptionthickenoption
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetThicknessOption ( int  thicknessOption)

Sets the thickness option.


Created in NX8.0.0.

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

Parameters
thicknessOptionthicknessoption
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetThicknessSourceOption ( NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessSourceOptions  thicknessSourceOption)

Sets the thickness source option.


Created in NX8.0.0.

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

Parameters
thicknessSourceOptionthicknesssourceoption
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetThicknessStr ( const NXString thicknessStr)

Sets the thickness in string format.


Created in NX10.0.1.

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

Parameters
thicknessStrthicknessstr
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetThicknessStr ( const char *  thicknessStr)

Sets the thickness in string format.


Created in NX10.0.1.

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

Parameters
thicknessStrthicknessstr
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetWeightRating ( const NXString weightRating)

Sets the weight rating, which is defined together with material data and has one to one relationship to the thickness.


Created in NX8.5.3.

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

Parameters
weightRatingweightrating
void NXOpen::Features::ShipDesign::PlateStockBuilder::SetWeightRating ( const char *  weightRating)

Sets the weight rating, which is defined together with material data and has one to one relationship to the thickness.


Created in NX8.5.3.

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

Parameters
weightRatingweightrating
NXOpen::Features::ShipDesign::PlateStockBuilder::ThickenOptions NXOpen::Features::ShipDesign::PlateStockBuilder::ThickenOption ( )

Returns the thicken option.


Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::PlateStockBuilder::Thickness ( )

Returns the thickness.


Created in NX8.0.0.

License requirements : None

int NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessOption ( )

Returns the thickness option.


Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessSourceOptions NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessSourceOption ( )

Returns the thickness source option.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::PlateStockBuilder::ThicknessStr ( )

Returns the thickness in string format.


Created in NX10.0.1.

License requirements : None

NXString NXOpen::Features::ShipDesign::PlateStockBuilder::WeightRating ( )

Returns the weight rating, which is defined together with material data and has one to one relationship to the thickness.


Created in NX8.5.3.

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.