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

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

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

Public Types

enum  CreationMethod { CreationMethodFace2Lines, CreationMethodSpecifyCSYS }
 available methods used to place a cutout object More...
 

Public Member Functions

NXOpen::ExpressionAngularDim ()
 Returns the angular dimension used to rotate the cutout's profile The angular dimension is only used for the Face2Lines placement method. More...
 
NXOpen::CoordinateSystemCoordSystem ()
 Returns the placement CSYS of the cutout. More...
 
bool KeepCoordSystem ()
 Returns the keep coordinate system A toggle used to remember the selected object on apply. More...
 
bool KeepReverseDirection1 ()
 Returns the toggle which allows re-use of the previous reverse direction toggle. More...
 
bool KeepReverseDirection2 ()
 Returns the toggle which allows re-use of the previous reverse direction toggle. More...
 
bool KeepSelectCSYSFace ()
 Returns the keep select csys face A toggle used to remember the selected object on apply. More...
 
bool KeepSelectLine1 ()
 Returns the keep select line1 A toggle used to remember the selected object on apply. More...
 
bool KeepSelectLine2 ()
 Returns the keep select line2 A toggle used to remember the selected object on apply. More...
 
bool KeepSelectTargetFace ()
 Returns the keep select target face A toggle used to remember the selected object on apply. More...
 
NXOpen::ExpressionLinearOffset1 ()
 Returns the linear offset distance from line1. More...
 
NXOpen::ExpressionLinearOffset2 ()
 Returns the linear offset distance from line2. More...
 
NXOpen::Features::ShipDesign::ShipCutoutBuilder::CreationMethod PlacementType ()
 Returns the placement type. More...
 
bool ReverseDirection1 ()
 Returns the reverse direction 1. More...
 
bool ReverseDirection2 ()
 Returns the reverse direction 2. More...
 
NXOpen::SelectFaceSelectCSYSFace ()
 Returns the selection object for the target face. More...
 
NXOpen::SelectNXObjectSelectLine1 ()
 Returns the select Line1. More...
 
NXOpen::SelectNXObjectSelectLine2 ()
 Returns the select Line2 This line 2 is only used for the Face2Lines placement method. More...
 
NXOpen::SelectNXObjectSelectTargetFace ()
 Returns the select Target Face. More...
 
void SetCoordSystem (NXOpen::CoordinateSystem *coordSystem)
 Sets the placement CSYS of the cutout. More...
 
void SetKeepCoordSystem (bool keepCoordSystem)
 Sets the keep coordinate system A toggle used to remember the selected object on apply. More...
 
void SetKeepReverseDirection1 (bool keepReverseDirection1)
 Sets the toggle which allows re-use of the previous reverse direction toggle. More...
 
void SetKeepReverseDirection2 (bool keepReverseDirection2)
 Sets the toggle which allows re-use of the previous reverse direction toggle. More...
 
void SetKeepSelectCSYSFace (bool keepSelectCSYSFace)
 Sets the keep select csys face A toggle used to remember the selected object on apply. More...
 
void SetKeepSelectLine1 (bool keepSelectLine1)
 Sets the keep select line1 A toggle used to remember the selected object on apply. More...
 
void SetKeepSelectLine2 (bool keepSelectLine2)
 Sets the keep select line2 A toggle used to remember the selected object on apply. More...
 
void SetKeepSelectTargetFace (bool keepSelectTargetFace)
 Sets the keep select target face A toggle used to remember the selected object on apply. More...
 
void SetPlacementType (NXOpen::Features::ShipDesign::ShipCutoutBuilder::CreationMethod placementType)
 Sets the placement type. More...
 
void SetReverseDirection1 (bool reverseDirection1)
 Sets the reverse direction 1. More...
 
void SetReverseDirection2 (bool reverseDirection2)
 Sets the reverse direction 2. More...
 
NXOpen::SketchExpressionModifierBuilderSketchBlock ()
 Returns the library sketch block that defines the Cutout outline
Created in NX7.5.0. 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::ShipCutout builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateShipCutoutBuilder
Default values.

Property Value

SketchBlock.Exp1.Value

0

SketchBlock.Exp10.Value

0

SketchBlock.Exp11.Value

0

SketchBlock.Exp12.Value

0

SketchBlock.Exp2.Value

0

SketchBlock.Exp3.Value

0

SketchBlock.Exp4.Value

0

SketchBlock.Exp5.Value

0

SketchBlock.Exp6.Value

0

SketchBlock.Exp7.Value

0

SketchBlock.Exp8.Value

0

SketchBlock.Exp9.Value

0

SketchBlock.Sketches

EndCut1


Created in NX7.5.0.

Member Enumeration Documentation

available methods used to place a cutout object

Enumerator
CreationMethodFace2Lines 

1 face and 2 lines, edges, or datums are used to place this cutout

CreationMethodSpecifyCSYS 

a csys is used to place this cutout

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::ShipCutoutBuilder::AngularDim ( )

Returns the angular dimension used to rotate the cutout's profile The angular dimension is only used for the Face2Lines placement method.


Created in NX7.5.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Features::ShipDesign::ShipCutoutBuilder::CoordSystem ( )

Returns the placement CSYS of the cutout.

The coordinate system is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepCoordSystem ( )

Returns the keep coordinate system A toggle used to remember the selected object on apply.

The keep coordinate system is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepReverseDirection1 ( )

Returns the toggle which allows re-use of the previous reverse direction toggle.

This is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepReverseDirection2 ( )

Returns the toggle which allows re-use of the previous reverse direction toggle.

This is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepSelectCSYSFace ( )

Returns the keep select csys face A toggle used to remember the selected object on apply.

The keep select csys face is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepSelectLine1 ( )

Returns the keep select line1 A toggle used to remember the selected object on apply.

The keep select line1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepSelectLine2 ( )

Returns the keep select line2 A toggle used to remember the selected object on apply.

The keep select line2 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::KeepSelectTargetFace ( )

Returns the keep select target face A toggle used to remember the selected object on apply.

The keep select target face is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShipCutoutBuilder::LinearOffset1 ( )

Returns the linear offset distance from line1.

The linear offset 1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShipCutoutBuilder::LinearOffset2 ( )

Returns the linear offset distance from line2.

The linear offset 2 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

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

Returns the placement type.

The creation method used to place the cutout object.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::ReverseDirection1 ( )

Returns the reverse direction 1.

Allows you to reverse the direction used in the linear offset 1. The reverse direction 1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipCutoutBuilder::ReverseDirection2 ( )

Returns the reverse direction 2.

Allows you to reverse the direction used in the linear offset 2. The reverse direction 2 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectFace* NXOpen::Features::ShipDesign::ShipCutoutBuilder::SelectCSYSFace ( )

Returns the selection object for the target face.

This target CSYS face is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::ShipCutoutBuilder::SelectLine1 ( )

Returns the select Line1.

This line 1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::ShipCutoutBuilder::SelectLine2 ( )

Returns the select Line2 This line 2 is only used for the Face2Lines placement method.


Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::ShipCutoutBuilder::SelectTargetFace ( )

Returns the select Target Face.

This target face is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetCoordSystem ( NXOpen::CoordinateSystem coordSystem)

Sets the placement CSYS of the cutout.

The coordinate system is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
coordSystemcoordsystem
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepCoordSystem ( bool  keepCoordSystem)

Sets the keep coordinate system A toggle used to remember the selected object on apply.

The keep coordinate system is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepCoordSystemkeepcoordsystem
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepReverseDirection1 ( bool  keepReverseDirection1)

Sets the toggle which allows re-use of the previous reverse direction toggle.

This is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepReverseDirection1keepreversedirection1
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepReverseDirection2 ( bool  keepReverseDirection2)

Sets the toggle which allows re-use of the previous reverse direction toggle.

This is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepReverseDirection2keepreversedirection2
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepSelectCSYSFace ( bool  keepSelectCSYSFace)

Sets the keep select csys face A toggle used to remember the selected object on apply.

The keep select csys face is only used for the SpecifyCSYS placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectCSYSFacekeepselectcsysface
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepSelectLine1 ( bool  keepSelectLine1)

Sets the keep select line1 A toggle used to remember the selected object on apply.

The keep select line1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectLine1keepselectline1
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepSelectLine2 ( bool  keepSelectLine2)

Sets the keep select line2 A toggle used to remember the selected object on apply.

The keep select line2 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectLine2keepselectline2
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetKeepSelectTargetFace ( bool  keepSelectTargetFace)

Sets the keep select target face A toggle used to remember the selected object on apply.

The keep select target face is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectTargetFacekeepselecttargetface
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetPlacementType ( NXOpen::Features::ShipDesign::ShipCutoutBuilder::CreationMethod  placementType)

Sets the placement type.

The creation method used to place the cutout object.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
placementTypeplacementtype
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetReverseDirection1 ( bool  reverseDirection1)

Sets the reverse direction 1.

Allows you to reverse the direction used in the linear offset 1. The reverse direction 1 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
reverseDirection1reversedirection1
void NXOpen::Features::ShipDesign::ShipCutoutBuilder::SetReverseDirection2 ( bool  reverseDirection2)

Sets the reverse direction 2.

Allows you to reverse the direction used in the linear offset 2. The reverse direction 2 is only used for the Face2Lines placement method.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
reverseDirection2reversedirection2
NXOpen::SketchExpressionModifierBuilder* NXOpen::Features::ShipDesign::ShipCutoutBuilder::SketchBlock ( )

Returns the library sketch block that defines the Cutout outline
Created in NX7.5.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.