NX Open C++ Reference Guide
|
Represents a NXOpen::Features::ShipDesign::Bracket builder. More...
Public Types | |
enum | AlignmentTypes { AlignmentTypesDatumPlaneAlignment, AlignmentTypesAutoAlignment, AlignmentTypesLapped } |
The alignment types. More... | |
enum | LimitTypes { LimitTypesNoLimit, LimitTypesOneLimit, LimitTypesTwoLimit, LimitTypesThreeLimit } |
The limit types. More... | |
Public Member Functions | |
NXOpen::Expression * | AlignmentAngle () |
Returns. More... | |
NXOpen::SelectDisplayableObject * | AlignmentPlane () |
Returns. More... | |
NXOpen::Features::ShipDesign::BracketBuilder::AlignmentTypes | AlignmentType () |
Returns. More... | |
double | AngularTolerance () |
Returns. More... | |
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | AttachmentDirection () |
Returns. More... | |
NXOpen::ScCollector * | AttachmentFace () |
Returns. More... | |
NXOpen::SelectDisplayableObjectList * | AttachmentStiffener () |
Returns. More... | |
NXOpen::Expression * | BracketOffset () |
Returns. More... | |
double | DistanceTolerance () |
Returns. More... | |
NXOpen::ScCollector * | EndAttachment () |
Returns. More... | |
NXOpen::Features::ShipDesign::BracketBuilder::LimitTypes | LimitType () |
Returns. More... | |
NXOpen::Features::ShipDesign::ManufacturingStockBuilder * | ManufacturingStock () |
Returns. More... | |
NXOpen::Point3d | PickPointOnAttachment () |
Returns. More... | |
NXOpen::Point3d | PickPointOnReinforcement () |
Returns. More... | |
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | ReinforcementDirection () |
Returns. More... | |
NXOpen::ScCollector * | ReinforcementFace () |
Returns. More... | |
NXOpen::SelectDisplayableObjectList * | ReinforcementStiffener () |
Returns. More... | |
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder * | SectionData () |
Returns. More... | |
void | SetAlignmentType (NXOpen::Features::ShipDesign::BracketBuilder::AlignmentTypes alignmentType) |
Sets. More... | |
void | SetAngularTolerance (double angularTolerance) |
Sets. More... | |
void | SetAttachmentDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction attachmentDirection) |
Sets. More... | |
void | SetDistanceTolerance (double distanceTolerance) |
Sets. More... | |
void | SetLimitType (NXOpen::Features::ShipDesign::BracketBuilder::LimitTypes limitType) |
Sets. More... | |
void | SetPickPointOnAttachment (const NXOpen::Point3d &pickPoint) |
Sets. More... | |
void | SetPickPointOnReinforcement (const NXOpen::Point3d &pickPoint) |
Sets. More... | |
void | SetReinforcementDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction reinforcementDirection) |
Sets. More... | |
void | SetThicknessDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction thicknessDirection) |
Sets. More... | |
NXOpen::Features::ShipDesign::ShipNamesBuilder * | ShipNames () |
Returns. More... | |
NXOpen::ScCollector * | StartAttachment () |
Returns. More... | |
NXOpen::ScCollector * | StartAttachmentLimit () |
Returns. More... | |
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | ThicknessDirection () |
Returns. More... | |
NXOpen::Weld::CharacteristicsBuilder * | WeldCharacteristics () |
Returns. More... | |
Public Member Functions inherited from NXOpen::Features::FeatureBuilder | |
NXOpen::Features::Feature * | CommitFeature () |
Commits the feature parameters and creates the feature. More... | |
NXOpen::Features::Feature * | GetFeature () |
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::NXObject * | Commit () |
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::NXObject * | GetObject () |
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... | |
Represents a NXOpen::Features::ShipDesign::Bracket builder.
This builder is used to create and edit bracket feature.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateBracketBuilder
Default values.
Property | Value |
---|---|
AlignmentAngle.Value |
0 |
AlignmentType |
DatumPlaneAlignment |
BracketOffset.Value |
0 (millimeters part), 0 (inches part) |
LimitType |
NoLimit |
Created in NX11.0.0.
The alignment types.
This option specifies how the bracket is aligned.
The limit types.
This option specifies how many limit objects there are.
NXOpen::Expression* NXOpen::Features::ShipDesign::BracketBuilder::AlignmentAngle | ( | ) |
Returns.
the alignment angle along attachment entity.
The bracket edge on reinforcement face side is rotated by this angle along the bracket edge on the attachment side.
The unit is in degree.
Created in NX11.0.0.
License requirements : None
NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::BracketBuilder::AlignmentPlane | ( | ) |
Returns.
the alignment plane.
The bracket molding face is aligned to the alignment plane if no offset is set in NXOpen::Features::ShipDesign::BracketBuilder::BracketOffset
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::BracketBuilder::AlignmentTypes NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType | ( | ) |
Returns.
the bracket alignment type.
If you set the alignment type to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment , then please also set values for below properties:
If you set the alignment type to Features::ShipDesign::BracketBuilder::AlignmentTypesAutoAlignment , then please also set values for below properties:
Created in NX11.0.0.
License requirements : None
double NXOpen::Features::ShipDesign::BracketBuilder::AngularTolerance | ( | ) |
Returns.
the angular tolerance (degrees)
The angular tolerance is used for:
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::BracketBuilder::AttachmentDirection | ( | ) |
Returns.
the install direction on attachment face.
The attachment direction defines which side the bracket is attached to the attachment face. You can either place the bracket on the attachment face normal side or the opposite side. The install directions are ship orientations based on the attachment face normal. For example: If the attachment face normal is in 'For' direction, then you should set the install direction to either 'For' or 'Aft'.
It is only used in Ship Structure Basic Design Application.
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : None
NXOpen::ScCollector* NXOpen::Features::ShipDesign::BracketBuilder::AttachmentFace | ( | ) |
Returns.
the attachment face.
The attachment face defines the faces which the bracket is attached to. You can attach the bracket to more than one faces.
The attachment face is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : None
NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::BracketBuilder::AttachmentStiffener | ( | ) |
Returns.
the attachment stiffener.
The bracket is attached to the stiffener body top face and aligned to the stiffener molding face if no offset is set in NXOpen::Features::ShipDesign::BracketBuilder::BracketOffset
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesAutoAlignment .
Created in NX11.0.0.
License requirements : None
NXOpen::Expression* NXOpen::Features::ShipDesign::BracketBuilder::BracketOffset | ( | ) |
Returns.
the offset to the alignment plane or attachment stiffener molding face.
If offset is zero, the bracket molding face is aligned to the alignment plane or attachment stiffener molding face.
Created in NX11.0.0.
License requirements : None
double NXOpen::Features::ShipDesign::BracketBuilder::DistanceTolerance | ( | ) |
Returns.
the distance tolerance (part units)
The distance tolerance is used for:
Created in NX11.0.0.
License requirements : None
NXOpen::ScCollector* NXOpen::Features::ShipDesign::BracketBuilder::EndAttachment | ( | ) |
Returns.
the end attachment.
This defines the limit object on the end side.
It is used when NXOpen::Features::ShipDesign::BracketBuilder::LimitType and NXOpen::Features::ShipDesign::BracketBuilder::SetLimitType is set to NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesTwoLimit or NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesThreeLimit .
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::BracketBuilder::LimitTypes NXOpen::Features::ShipDesign::BracketBuilder::LimitType | ( | ) |
Returns.
the limit type.
If you set the limit type to Features::ShipDesign::BracketBuilder::LimitTypesNoLimit , you don't need to set any limit object.
If you set the limit type to Features::ShipDesign::BracketBuilder::LimitTypesOneLimit , then please also set value for NXOpen::Features::ShipDesign::BracketBuilder::StartAttachment .
If you set the alignment type to Features::ShipDesign::BracketBuilder::LimitTypesTwoLimit , then please also set values for below properties:
If you set the alignment type to NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesThreeLimit , then please also set values for below properties:
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::ManufacturingStockBuilder* NXOpen::Features::ShipDesign::BracketBuilder::ManufacturingStock | ( | ) |
Returns.
the manufacturing stock.
The manufacturing stock defines data that is to be applied to the bracket.
Created in NX11.0.0.
License requirements : None
NXOpen::Point3d NXOpen::Features::ShipDesign::BracketBuilder::PickPointOnAttachment | ( | ) |
Returns.
the pick point on attachment face.
When the attachment face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The position which is closest to the pick point is used.
It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : None
NXOpen::Point3d NXOpen::Features::ShipDesign::BracketBuilder::PickPointOnReinforcement | ( | ) |
Returns.
the pick point on reinforcement face.
When the reinforcement face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The location which is closest to the pick point is used.
It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::BracketBuilder::ReinforcementDirection | ( | ) |
Returns.
the install direction on reinforcement face.
The reinforcement direction defines which side the bracket is placed on the reinforcement face. You can either place the bracket on the reinforcement face normal side or the opposite side. The install directions are ship orientations based on the reinforcement face normal. For example: If the reinforcement face normal is in 'For' direction, then you should set the install direction to either 'For' or 'Aft'.
It is only used in Ship Structure Basic Design Application.
Created in NX11.0.0.
License requirements : None
NXOpen::ScCollector* NXOpen::Features::ShipDesign::BracketBuilder::ReinforcementFace | ( | ) |
Returns.
the reinforcement face.
The reinforcement face defines the objects which need to be reinforced. More than one faces can be reinforced by the bracket.
Created in NX11.0.0.
License requirements : None
NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::BracketBuilder::ReinforcementStiffener | ( | ) |
Returns.
the reinforcement stiffener.
The reinforcement stiffener defines the objects which need to be reinforced.
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesLapped .
Created in NX12.0.0.
License requirements : None
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder* NXOpen::Features::ShipDesign::BracketBuilder::SectionData | ( | ) |
Returns.
the section data.
The section data defines the shape of the bracket and expressions to control the size of the bracket.
Created in NX11.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType | ( | NXOpen::Features::ShipDesign::BracketBuilder::AlignmentTypes | alignmentType | ) |
Sets.
the bracket alignment type.
If you set the alignment type to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment , then please also set values for below properties:
If you set the alignment type to Features::ShipDesign::BracketBuilder::AlignmentTypesAutoAlignment , then please also set values for below properties:
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
alignmentType | Alignment type |
void NXOpen::Features::ShipDesign::BracketBuilder::SetAngularTolerance | ( | double | angularTolerance | ) |
Sets.
the angular tolerance (degrees)
The angular tolerance is used for:
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
angularTolerance | angulartolerance |
void NXOpen::Features::ShipDesign::BracketBuilder::SetAttachmentDirection | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | attachmentDirection | ) |
Sets.
the install direction on attachment face.
The attachment direction defines which side the bracket is attached to the attachment face. You can either place the bracket on the attachment face normal side or the opposite side. The install directions are ship orientations based on the attachment face normal. For example: If the attachment face normal is in 'For' direction, then you should set the install direction to either 'For' or 'Aft'.
It is only used in Ship Structure Basic Design Application.
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
attachmentDirection | attachmentdirection |
void NXOpen::Features::ShipDesign::BracketBuilder::SetDistanceTolerance | ( | double | distanceTolerance | ) |
Sets.
the distance tolerance (part units)
The distance tolerance is used for:
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
distanceTolerance | distancetolerance |
void NXOpen::Features::ShipDesign::BracketBuilder::SetLimitType | ( | NXOpen::Features::ShipDesign::BracketBuilder::LimitTypes | limitType | ) |
Sets.
the limit type.
If you set the limit type to Features::ShipDesign::BracketBuilder::LimitTypesNoLimit , you don't need to set any limit object.
If you set the limit type to Features::ShipDesign::BracketBuilder::LimitTypesOneLimit , then please also set value for NXOpen::Features::ShipDesign::BracketBuilder::StartAttachment .
If you set the alignment type to Features::ShipDesign::BracketBuilder::LimitTypesTwoLimit , then please also set values for below properties:
If you set the alignment type to NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesThreeLimit , then please also set values for below properties:
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
limitType | Limit type |
void NXOpen::Features::ShipDesign::BracketBuilder::SetPickPointOnAttachment | ( | const NXOpen::Point3d & | pickPoint | ) |
Sets.
the pick point on attachment face.
When the attachment face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The position which is closest to the pick point is used.
It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.
It is only used when NXOpen::Features::ShipDesign::BracketBuilder::AlignmentType and NXOpen::Features::ShipDesign::BracketBuilder::SetAlignmentType is set to Features::ShipDesign::BracketBuilder::AlignmentTypesDatumPlaneAlignment .
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
pickPoint | pickpoint |
void NXOpen::Features::ShipDesign::BracketBuilder::SetPickPointOnReinforcement | ( | const NXOpen::Point3d & | pickPoint | ) |
Sets.
the pick point on reinforcement face.
When the reinforcement face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The location which is closest to the pick point is used.
It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
pickPoint | Pick Point type |
void NXOpen::Features::ShipDesign::BracketBuilder::SetReinforcementDirection | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | reinforcementDirection | ) |
Sets.
the install direction on reinforcement face.
The reinforcement direction defines which side the bracket is placed on the reinforcement face. You can either place the bracket on the reinforcement face normal side or the opposite side. The install directions are ship orientations based on the reinforcement face normal. For example: If the reinforcement face normal is in 'For' direction, then you should set the install direction to either 'For' or 'Aft'.
It is only used in Ship Structure Basic Design Application.
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
reinforcementDirection | reinforcementdirection |
void NXOpen::Features::ShipDesign::BracketBuilder::SetThicknessDirection | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction | thicknessDirection | ) |
Sets.
the thickness direction.
Created in NX11.0.0.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
thicknessDirection | Thickness direction |
NXOpen::Features::ShipDesign::ShipNamesBuilder* NXOpen::Features::ShipDesign::BracketBuilder::ShipNames | ( | ) |
Returns.
the ship name.
The ship name is used to assign name to the bracket.
It is only used in Ship Structure Basic Design Application.
Created in NX11.0.0.
License requirements : None
NXOpen::ScCollector* NXOpen::Features::ShipDesign::BracketBuilder::StartAttachment | ( | ) |
Returns.
the start attachment.
This defines the limit object on the start side.
It is used when NXOpen::Features::ShipDesign::BracketBuilder::LimitType and NXOpen::Features::ShipDesign::BracketBuilder::SetLimitType is set to NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesOneLimit or NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesTwoLimit or NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesThreeLimit .
Created in NX11.0.0.
License requirements : None
NXOpen::ScCollector* NXOpen::Features::ShipDesign::BracketBuilder::StartAttachmentLimit | ( | ) |
Returns.
the start attachment limit.
This defines the limit object on the start attachment entity.
It is used when NXOpen::Features::ShipDesign::BracketBuilder::LimitType and NXOpen::Features::ShipDesign::BracketBuilder::SetLimitType is set to NXOpen::Features::ShipDesign::BracketBuilder::LimitTypesThreeLimit .
Created in NX11.0.0.
License requirements : None
NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::BracketBuilder::ThicknessDirection | ( | ) |
Returns.
the thickness direction.
Created in NX11.0.0.
License requirements : None
NXOpen::Weld::CharacteristicsBuilder* NXOpen::Features::ShipDesign::BracketBuilder::WeldCharacteristics | ( | ) |
Returns.
the weld characteristics.
The weld characteristics defines data that is to be applied to the bracket weld edges.
Created in NX11.0.0.
License requirements : None