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

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

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

Public Member Functions

std::vector< NXStringGetAvailablePlateSizes ()
 The list of available plate sizes. More...
 
bool IsInternal ()
 Returns the is internal toggle. More...
 
bool KeepSelectFace ()
 Returns the keep select face. More...
 
bool KeepSelectProfileBody ()
 Returns the keep select profile body. More...
 
int PlateSize ()
 Returns the plate size. More...
 
NXOpen::SelectFaceSelectFace ()
 Returns the select face. More...
 
NXOpen::SelectBodySelectProfileBody ()
 Returns the select profile body. More...
 
void SetInternal (bool isInternal)
 Sets the is internal toggle. More...
 
void SetKeepSelectFace (bool keepSelectFace)
 Sets the keep select face. More...
 
void SetKeepSelectProfileBody (bool keepSelectProfileBody)
 Sets the keep select profile body. More...
 
void SetPlateSize (int plateSize)
 Sets the plate size. 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::SteelCollarPlate builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateSteelCollarPlateBuilder
Default values.

Property Value

IsInternal

0

KeepSelectFace

0

KeepSelectProfileBody

0


Created in NX7.5.0.

Member Function Documentation

std::vector<NXString> NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::GetAvailablePlateSizes ( )

The list of available plate sizes.

Note this list will change every time the selected profile body changes.

Returns
Array of available plate sizes. These names are specified by a special sketch naming convention for sketches loaded in the profile library.
Created in NX7.5.0.

License requirements : None
bool NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::IsInternal ( )

Returns the is internal toggle.

Is this plate inside the profile cutout, or slapped onto the outside of the placement face?
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::KeepSelectFace ( )

Returns the keep select face.

Determines whether or not we should reuse the same selected face on apply.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::KeepSelectProfileBody ( )

Returns the keep select profile body.

Determines whether or not we should reuse the same selected profile body on apply.
Created in NX7.5.0.

License requirements : None

int NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::PlateSize ( )

Returns the plate size.

Note: when the selected profile body changes, the available sizes will also change. Therefore, after changing the selected profile, you must call GetAvailablePlateSizes before you can set this PlateSize value.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectFace* NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SelectFace ( )

Returns the select face.

The face is used along with the profile body to determine the placement of the collar plate feature. Typically this face will already have a profile cutout feature and the collar plate is used to "fill the gap" caused by the profile cutout.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SelectProfileBody ( )

Returns the select profile body.

The profile body determines what sizes of collar plate features are available, and where to place the collar plate feature.
Created in NX7.5.0.

License requirements : None

void NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SetInternal ( bool  isInternal)

Sets the is internal toggle.

Is this plate inside the profile cutout, or slapped onto the outside of the placement face?
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
isInternalisinternal
void NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SetKeepSelectFace ( bool  keepSelectFace)

Sets the keep select face.

Determines whether or not we should reuse the same selected face on apply.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectFacekeepselectface
void NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SetKeepSelectProfileBody ( bool  keepSelectProfileBody)

Sets the keep select profile body.

Determines whether or not we should reuse the same selected profile body on apply.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectProfileBodykeepselectprofilebody
void NXOpen::Features::ShipDesign::SteelCollarPlateBuilder::SetPlateSize ( int  plateSize)

Sets the plate size.

Note: when the selected profile body changes, the available sizes will also change. Therefore, after changing the selected profile, you must call GetAvailablePlateSizes before you can set this PlateSize value.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
plateSizeplatesize

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