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

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

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

Public Types

enum  CreationMethod { CreationMethodPlanesAndPoint, CreationMethodSpecifyCSYS }
 Creation method used to define the placement of the bracket. More...
 

Public Member Functions

int AttributeMaterial ()
 Returns the material attribute
Created in NX7.5.0. More...
 
int AttributeName ()
 Returns the name attribute value
Created in NX7.5.0. More...
 
NXOpen::CoordinateSystemCoordSystem ()
 Returns the placement csys of the bracket
Created in NX7.5.0. More...
 
std::vector< NXStringGetAvailableAttributeMaterials ()
 Returns the list of available material attributes. More...
 
std::vector< NXStringGetAvailableAttributeNames ()
 Returns the list of available name attributes. More...
 
NXOpen::ExpressionHeelOffset ()
 Returns the heel offset
Created in NX7.5.0. More...
 
NXOpen::PointHeelPoint ()
 Returns the heel point
Created in NX7.5.0. More...
 
bool KeepCoordSystem ()
 Returns the toggle which allows re-use of the previous coordinate system
Created in NX7.5.0. More...
 
bool KeepHeelPoint ()
 Returns the toggle which allows re-use of the previous heel point
Created in NX7.5.0. More...
 
bool KeepPlacementPlane ()
 Returns the toggle which allows re-use of the previous placement plane
Created in NX7.5.0. More...
 
bool KeepReferencePlane ()
 Returns the toggle which allows re-use of the previous reference plane
Created in NX7.5.0. More...
 
bool KeepReverseDirection ()
 Returns the toggle which allows re-use of the previous flip direction toggle
Created in NX7.5.0. More...
 
bool KeepSelectTrimFace ()
 Returns the keep select trim face A toggle used to remember the selected object(s) on apply. More...
 
NXOpen::PlanePlacementPlane ()
 Returns the placement plane
Created in NX7.5.0. More...
 
NXOpen::Features::ShipDesign::CustomBracketBuilder::CreationMethod PlacementType ()
 Returns the method used to define the placement of the bracket
Created in NX7.5.0. More...
 
NXOpen::PlaneReferencePlane ()
 Returns the reference plane
Created in NX7.5.0. More...
 
bool ReverseDirection ()
 Returns the flip direction toggle for the extrude direction
Created in NX7.5.0. More...
 
NXOpen::ScCollectorSelectTrimFace ()
 Returns the select trim face. More...
 
void SetAttributeMaterial (int material)
 Sets the material attribute
Created in NX7.5.0. More...
 
void SetAttributeName (int name)
 Sets the name attribute value
Created in NX7.5.0. More...
 
void SetCoordSystem (NXOpen::CoordinateSystem *coordSystem)
 Sets the placement csys of the bracket
Created in NX7.5.0. More...
 
void SetHeelPoint (NXOpen::Point *heelPoint)
 Sets the heel point
Created in NX7.5.0. More...
 
void SetKeepCoordSystem (bool keepCoordSystem)
 Sets the toggle which allows re-use of the previous coordinate system
Created in NX7.5.0. More...
 
void SetKeepHeelPoint (bool keepHeelPoint)
 Sets the toggle which allows re-use of the previous heel point
Created in NX7.5.0. More...
 
void SetKeepPlacementPlane (bool keepPlacementPlane)
 Sets the toggle which allows re-use of the previous placement plane
Created in NX7.5.0. More...
 
void SetKeepReferencePlane (bool keepReferencePlane)
 Sets the toggle which allows re-use of the previous reference plane
Created in NX7.5.0. More...
 
void SetKeepReverseDirection (bool keepReverseDirection)
 Sets the toggle which allows re-use of the previous flip direction toggle
Created in NX7.5.0. More...
 
void SetKeepSelectTrimFace (bool keepSelectTrimFace)
 Sets the keep select trim face A toggle used to remember the selected object(s) on apply. More...
 
void SetPlacementPlane (NXOpen::Plane *placementPlane)
 Sets the placement plane
Created in NX7.5.0. More...
 
void SetPlacementType (NXOpen::Features::ShipDesign::CustomBracketBuilder::CreationMethod placementType)
 Sets the method used to define the placement of the bracket
Created in NX7.5.0. More...
 
void SetReferencePlane (NXOpen::Plane *referencePlane)
 Sets the reference plane
Created in NX7.5.0. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the flip direction toggle for the extrude direction
Created in NX7.5.0. More...
 
NXOpen::SketchExpressionModifierBuilderSketchBlock ()
 Returns the sketch block
Created in NX7.5.0. More...
 
NXOpen::ExpressionThickness ()
 Returns the thickness of the bracket
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::CustomBracket builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateCustomBracketBuilder
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

Creation method used to define the placement of the bracket.

Enumerator
CreationMethodPlanesAndPoint 

planes and point

CreationMethodSpecifyCSYS 

specify csys

Member Function Documentation

int NXOpen::Features::ShipDesign::CustomBracketBuilder::AttributeMaterial ( )

Returns the material attribute
Created in NX7.5.0.



License requirements : None

int NXOpen::Features::ShipDesign::CustomBracketBuilder::AttributeName ( )

Returns the name attribute value
Created in NX7.5.0.



License requirements : None

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

Returns the placement csys of the bracket
Created in NX7.5.0.



License requirements : None

std::vector<NXString> NXOpen::Features::ShipDesign::CustomBracketBuilder::GetAvailableAttributeMaterials ( )

Returns the list of available material attributes.

Returns
Array of available attribute materials. These materials are specified in the customer defaults file.
Created in NX7.5.0.

License requirements : None
std::vector<NXString> NXOpen::Features::ShipDesign::CustomBracketBuilder::GetAvailableAttributeNames ( )

Returns the list of available name attributes.

Returns
Array of available attribute names. These names are specified in the customer defaults file.
Created in NX7.5.0.

License requirements : None
NXOpen::Expression* NXOpen::Features::ShipDesign::CustomBracketBuilder::HeelOffset ( )

Returns the heel offset
Created in NX7.5.0.



License requirements : None

NXOpen::Point* NXOpen::Features::ShipDesign::CustomBracketBuilder::HeelPoint ( )

Returns the heel point
Created in NX7.5.0.



License requirements : None

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

Returns the toggle which allows re-use of the previous coordinate system
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::KeepHeelPoint ( )

Returns the toggle which allows re-use of the previous heel point
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::KeepPlacementPlane ( )

Returns the toggle which allows re-use of the previous placement plane
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::KeepReferencePlane ( )

Returns the toggle which allows re-use of the previous reference plane
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::KeepReverseDirection ( )

Returns the toggle which allows re-use of the previous flip direction toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::KeepSelectTrimFace ( )

Returns the keep select trim face A toggle used to remember the selected object(s) on apply.


Created in NX7.5.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::CustomBracketBuilder::PlacementPlane ( )

Returns the placement plane
Created in NX7.5.0.



License requirements : None

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

Returns the method used to define the placement of the bracket
Created in NX7.5.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::CustomBracketBuilder::ReferencePlane ( )

Returns the reference plane
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::CustomBracketBuilder::ReverseDirection ( )

Returns the flip direction toggle for the extrude direction
Created in NX7.5.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::CustomBracketBuilder::SelectTrimFace ( )

Returns the select trim face.

Specifies the face(s) to cut holes in.
Created in NX7.5.0.

License requirements : None

void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetAttributeMaterial ( int  material)

Sets the material attribute
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
materialmaterial
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetAttributeName ( int  name)

Sets the name attribute value
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
namename
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetCoordSystem ( NXOpen::CoordinateSystem coordSystem)

Sets the placement csys of the bracket
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
coordSystemcoordsystem
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetHeelPoint ( NXOpen::Point heelPoint)

Sets the heel point
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
heelPointheelpoint
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepCoordSystem ( bool  keepCoordSystem)

Sets the toggle which allows re-use of the previous coordinate system
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepCoordSystemkeepcoordsystem
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepHeelPoint ( bool  keepHeelPoint)

Sets the toggle which allows re-use of the previous heel point
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepHeelPointkeepheelpoint
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepPlacementPlane ( bool  keepPlacementPlane)

Sets the toggle which allows re-use of the previous placement plane
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepPlacementPlanekeepplacementplane
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepReferencePlane ( bool  keepReferencePlane)

Sets the toggle which allows re-use of the previous reference plane
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepReferencePlanekeepreferenceplane
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepReverseDirection ( bool  keepReverseDirection)

Sets the toggle which allows re-use of the previous flip direction toggle
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepReverseDirectionkeepreversedirection
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetKeepSelectTrimFace ( bool  keepSelectTrimFace)

Sets the keep select trim face A toggle used to remember the selected object(s) on apply.


Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
keepSelectTrimFacekeepselecttrimface
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetPlacementPlane ( NXOpen::Plane placementPlane)

Sets the placement plane
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
placementPlaneplacementplane
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetPlacementType ( NXOpen::Features::ShipDesign::CustomBracketBuilder::CreationMethod  placementType)

Sets the method used to define the placement of the bracket
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
placementTypeplacementtype
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetReferencePlane ( NXOpen::Plane referencePlane)

Sets the reference plane
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
referencePlanereferenceplane
void NXOpen::Features::ShipDesign::CustomBracketBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the flip direction toggle for the extrude direction
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
reverseDirectionreversedirection
NXOpen::SketchExpressionModifierBuilder* NXOpen::Features::ShipDesign::CustomBracketBuilder::SketchBlock ( )

Returns the sketch block
Created in NX7.5.0.



License requirements : None

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

Returns the thickness of the bracket
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.