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

This class is used to define the boundary of the regions when definining the orientation of a profile. More...

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

Public Types

enum  MeasureAlongTypes { MeasureAlongTypesCurve, MeasureAlongTypesAxis }
 Settings to indicate how the distance is measured. More...
 
enum  PointMethodTypes { PointMethodTypesByPoint, PointMethodTypesByDistance, PointMethodTypesFromStart, PointMethodTypesFromEnd }
 Settings to indicate how the boundary is defined. More...
 

Public Member Functions

NXOpen::ExpressionDistance ()
 Returns the distance used to determine the boundary of the region. More...
 
NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::MeasureAlongTypes MeasureAlong ()
 Returns the indication of how to measure the distance used to determine the boundary of the region. More...
 
NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypes PointMethod ()
 Returns the method used to define the boundary. More...
 
NXOpen::SelectNXObjectReference ()
 Returns the object used to measure the distance from to determine the boundary of the region. More...
 
void SetMeasureAlong (NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::MeasureAlongTypes measureAlong)
 Sets the indication of how to measure the distance used to determine the boundary of the region. More...
 
void SetPointMethod (NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypes pointMethod)
 Sets the method used to define the boundary. More...
 
void SetSpecifyPoint (NXOpen::Point *specifyPoint)
 Sets the point used to determine the boundary of the region. More...
 
NXOpen::PointSpecifyPoint ()
 Returns the point used to determine the boundary of the region. 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 is used to define the boundary of the regions when definining the orientation of a profile.


Created in NX9.0.0.

Member Enumeration Documentation

Settings to indicate how the distance is measured.

Enumerator
MeasureAlongTypesCurve 

The distance is measured along the landing curve.

MeasureAlongTypesAxis 

The distance is measured along the orthogonal direction closest to the landing curve tangent direction.

Settings to indicate how the boundary is defined.

Enumerator
PointMethodTypesByPoint 

The boundary is defined by a location on the landing curve closest to a specified point.

PointMethodTypesByDistance 

The boundary is defined by a distance from a reference object.

PointMethodTypesFromStart 

The boundary is defined by a distance from the start of the landing curve.

PointMethodTypesFromEnd 

The boundary is defined by a distance from the end of the landing curve.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::Distance ( )

Returns the distance used to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByDistance , Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromStart , or Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromEnd .
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::MeasureAlongTypes NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::MeasureAlong ( )

Returns the indication of how to measure the distance used to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByDistance , Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromStart , or Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromEnd .
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypes NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::PointMethod ( )

Returns the method used to define the boundary.


Created in NX9.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::Reference ( )

Returns the object used to measure the distance from to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByDistance .
Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::SetMeasureAlong ( NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::MeasureAlongTypes  measureAlong)

Sets the indication of how to measure the distance used to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByDistance , Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromStart , or Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesFromEnd .
Created in NX9.0.0.

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

Parameters
measureAlongmeasurealong
void NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::SetPointMethod ( NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypes  pointMethod)

Sets the method used to define the boundary.


Created in NX9.0.0.

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

Parameters
pointMethodpointmethod
void NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::SetSpecifyPoint ( NXOpen::Point specifyPoint)

Sets the point used to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByPoint .
Created in NX9.0.0.

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

Parameters
specifyPointspecifypoint
NXOpen::Point* NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::SpecifyPoint ( )

Returns the point used to determine the boundary of the region.

Only used when PointMethod is Features::ShipDesign::OrientationPointMethodsBuilder::PointMethodTypesByPoint .
Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder::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.