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

This class defines the builder to collect stiffener by support path data for Stiffener feature. More...

Inheritance diagram for NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AlignedTo { AlignedToWeb, AlignedToFlange }
 Which face the stiffener is aligned to. More...
 
enum  Method {
  MethodAlignedBoundary, MethodAlignedLength, MethodBoundToBound, MethodParallelToLine,
  MethodHorizontal, MethodVertical, MethodNormalToCurve, MethodThroughPoint
}
 Type of Stiffener by Support Method. More...
 
enum  Scenario { ScenarioBasicDesign, ScenarioDetailDesign }
 Scenarios of Stiffener by Support. More...
 
enum  SetBackMethod { SetBackMethodBoundingStiffenerHeight, SetBackMethodSBSWebThickeness }
 Type of set back method. More...
 

Public Member Functions

NXOpen::ExpressionAngle ()
 Returns the angle of horizontal or vertical method, in degrees
Created in NX9.0.0. More...
 
void ClearBoundaryToAttachedBoundaryMap ()
 Clear the map of boundary to attached boundary. More...
 
NXOpen::SelectDisplayableObjectEndBoundary ()
 Returns the end boundary objects. More...
 
NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::AlignedTo LengthAlignMethod ()
 Returns the aligned length method
Created in NX9.0.0. More...
 
NXOpen::ExpressionLengthParams ()
 Returns the length parameter, which defines the stiffener by support length when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength . More...
 
NXOpen::SelectDisplayableObjectListMultipleSelectionEndBoundary ()
 Returns the multiple end boundary objects. More...
 
bool OrientationBySupport ()
 Returns the flag to indicate whether the orientation of the stiffener is aligned to the start boundary. More...
 
NXOpen::SelectNXObjectRefParallelLine ()
 Returns the referenced parallel line for stiffener by support path
Created in NX9.0.0. More...
 
NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetBackMethod SetbackMethod ()
 Returns the setback method. More...
 
void SetLengthAlignMethod (NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::AlignedTo method)
 Sets the aligned length method
Created in NX9.0.0. More...
 
void SetOrientationBySupport (bool orientationBySupport)
 Sets the flag to indicate whether the orientation of the stiffener is aligned to the start boundary. More...
 
void SetSetbackMethod (NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetBackMethod setbackMethod)
 Sets the setback method. More...
 
void SetStiffenerBySupportMethod (NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method method)
 Sets the stiffener by support path method
Created in NX9.0.0. More...
 
void SetSwitchSide (bool switchSide)
 Sets the switch side flag, which can change the stiffener by support orienation when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength . More...
 
void SetThroughPointLocation (NXOpen::Point *throughPointLocation)
 Sets the through point location. More...
 
NXOpen::SelectDisplayableObjectListStartBoundary ()
 Returns the start boundary, it allows to select curve, sheet body and solid body
Created in NX9.0.0. More...
 
NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method StiffenerBySupportMethod ()
 Returns the stiffener by support path method
Created in NX9.0.0. More...
 
bool SwitchSide ()
 Returns the switch side flag, which can change the stiffener by support orienation when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength . More...
 
NXOpen::PointThroughPointLocation ()
 Returns the through point location. 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 class defines the builder to collect stiffener by support path data for Stiffener feature.


Created in NX9.0.0.

Member Enumeration Documentation

Which face the stiffener is aligned to.

Enumerator
AlignedToWeb 

web

AlignedToFlange 

flange

Type of Stiffener by Support Method.

Enumerator
MethodAlignedBoundary 

Aligned Boundary.

MethodAlignedLength 

Aligned Length.

MethodBoundToBound 

Bound to Bound.

MethodParallelToLine 

Parallel to Line.

MethodHorizontal 

Horizontal.

MethodVertical 

Vertical.

MethodNormalToCurve 

Normal to Curve.

MethodThroughPoint 

Through Point.

Scenarios of Stiffener by Support.

Enumerator
ScenarioBasicDesign 

Basic Design Scenario.

ScenarioDetailDesign 

Detail Design Scenario.

Type of set back method.

Enumerator
SetBackMethodBoundingStiffenerHeight 

Bounding Stiffener Height.

SetBackMethodSBSWebThickeness 

SBS Web Thickness.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Angle ( )

Returns the angle of horizontal or vertical method, in degrees
Created in NX9.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::ClearBoundaryToAttachedBoundaryMap ( )

Clear the map of boundary to attached boundary.


Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::EndBoundary ( )

Returns the end boundary objects.

It allows to select curve, sheet body and solid body.

Deprecated:
Deprecated in NX11.0.1. Use NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder .GetMultipleSelectionEndBoundary instead.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::AlignedTo NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::LengthAlignMethod ( )

Returns the aligned length method
Created in NX9.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::LengthParams ( )

Returns the length parameter, which defines the stiffener by support length when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength .


Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MultipleSelectionEndBoundary ( )

Returns the multiple end boundary objects.

It allows to select curve, sheet body and solid body.
Created in NX11.0.1.

License requirements : None

bool NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::OrientationBySupport ( )

Returns the flag to indicate whether the orientation of the stiffener is aligned to the start boundary.


Created in NX9.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::RefParallelLine ( )

Returns the referenced parallel line for stiffener by support path
Created in NX9.0.0.



License requirements : None

NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetBackMethod NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetbackMethod ( )

Returns the setback method.


Created in NX11.0.0.

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

void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetLengthAlignMethod ( NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::AlignedTo  method)

Sets the aligned length method
Created in NX9.0.0.



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

Parameters
methodmethod
void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetOrientationBySupport ( bool  orientationBySupport)

Sets the flag to indicate whether the orientation of the stiffener is aligned to the start boundary.


Created in NX9.0.0.

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

Parameters
orientationBySupportorientationbysupport
void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetSetbackMethod ( NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetBackMethod  setbackMethod)

Sets the setback method.


Created in NX11.0.0.

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

Parameters
setbackMethodsetbackmethod
void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetStiffenerBySupportMethod ( NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method  method)

Sets the stiffener by support path method
Created in NX9.0.0.



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

Parameters
methodmethod
void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetSwitchSide ( bool  switchSide)

Sets the switch side flag, which can change the stiffener by support orienation when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength .


Created in NX9.0.0.

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

Parameters
switchSideswitchside
void NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SetThroughPointLocation ( NXOpen::Point throughPointLocation)

Sets the through point location.


Created in NX9.0.0.

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

Parameters
throughPointLocationthroughpointlocation
NXOpen::SelectDisplayableObjectList* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::StartBoundary ( )

Returns the start boundary, it allows to select curve, sheet body and solid body
Created in NX9.0.0.



License requirements : None

NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::StiffenerBySupportMethod ( )

Returns the stiffener by support path method
Created in NX9.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::SwitchSide ( )

Returns the switch side flag, which can change the stiffener by support orienation when the NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Method is NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::MethodAlignedLength .


Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::ThroughPointLocation ( )

Returns the through point location.


Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Features::ShipDesign::StiffenerBySupportPathBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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