NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::ShipDesign::PillarBuilder Class Reference

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

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

List of all members.

Public Types

enum  CapOptions { CapOptionsNone, CapOptionsTwoSided, CapOptionsSymmetric }
 Settings to indicate how the cap is designed. More...
enum  CreationMethod { CreationMethodTwoPlanesandLines, CreationMethodSpecifyLine, CreationMethodSpecifyCsys }
 Method used to create the support feature. More...

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance.
NXOpen::ExpressionAngularDim ()
 Returns the angle that the pillar stock will be rotated about its path from its initial location.
NXOpen::CoordinateSystemCoordSystem ()
 Returns the coord system (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation method).
double DistanceTolerance ()
 Returns the distance tolerance.
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderEndCapStock ()
 Returns the list of available material attributes.
NXOpen::ExpressionEndCapThickness ()
 Returns the end cap thickness.
NXOpen::ExpressionEndOffset ()
 Returns the offset used to determine where the support ends (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
NXOpen::PlaneEndPlane ()
 Returns the end plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::SelectTaggedObjectGuideCurve ()
 Returns the select guide curve (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" creation method).
NXOpen::SelectTaggedObjectLine1 ()
 Returns the first line (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::ExpressionLine1Offset ()
 Returns the first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::SelectTaggedObjectLine2 ()
 Returns the second line (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::ExpressionLine2Offset ()
 Returns the second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderMainStock ()
 Returns the stock used to build the pillar from.
NXOpen::SelectTaggedObjectOrientationLine ()
 Returns the orientation line (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" creation method).
NXOpen::Features::ShipDesign::PillarBuilder::CreationMethod PlacementMethod ()
 Returns the placement method used to locate the pillar.
bool ReverseEndOffset ()
 Returns the reverse end offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
bool ReverseLine1Offset ()
 Returns the reverse first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
bool ReverseLine2Offset ()
 Returns the reverse second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
bool ReverseStartOffset ()
 Returns the reverse start offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance.
void SetCoordSystem (NXOpen::CoordinateSystem *coordSystem)
 Sets the coord system (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation method).
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance.
void SetEndPlane (NXOpen::Plane *endPlane)
 Sets the end plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
void SetPlacementMethod (NXOpen::Features::ShipDesign::PillarBuilder::CreationMethod placementMethod)
 Sets the placement method used to locate the pillar.
void SetReverseEndOffset (bool reverseEndOffset)
 Sets the reverse end offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
void SetReverseLine1Offset (bool reverseLine1Offset)
 Sets the reverse first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
void SetReverseLine2Offset (bool reverseLine2Offset)
 Sets the reverse second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
void SetReverseStartOffset (bool reverseStartOffset)
 Sets the reverse start offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
void SetStartPlane (NXOpen::Plane *startPlane)
 Sets the start plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
void SetSupportCapOptions (NXOpen::Features::ShipDesign::PillarBuilder::CapOptions supportCapOptions)
 Sets the support cap options.
NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilderStartCapStock ()
 Returns the list of available material attributes.
NXOpen::ExpressionStartCapThickness ()
 Returns the start cap thickness.
NXOpen::ExpressionStartOffset ()
 Returns the offset used to determine where the support starts (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).
NXOpen::PlaneStartPlane ()
 Returns the start plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).
NXOpen::Features::ShipDesign::PillarBuilder::CapOptions SupportCapOptions ()
 Returns the support cap options.

Detailed Description

Represents a Features::ShipDesign::Pillar builder
To create a new instance of this class, use Features::ShipCollection::CreatePillarBuilder
Default values.

Property Value

AngleTolerance

0.5 (millimeters part), 0.5 (inches part)

AngularDim.Value

0

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)

EndCapThickness.Value

0 (millimeters part), 0 (inches part)

EndOffset.Value

0 (millimeters part), 0 (inches part)

Line1Offset.Value

0 (millimeters part), 0 (inches part)

Line2Offset.Value

0 (millimeters part), 0 (inches part)

PlacementMethod

TwoPlanesandLines

StartCapThickness.Value

0 (millimeters part), 0 (inches part)

StartOffset.Value

0 (millimeters part), 0 (inches part)

SupportCapOptions

None


Created in NX8.0.0.


Member Enumeration Documentation

Settings to indicate how the cap is designed.

Enumerator:
CapOptionsNone 

none

CapOptionsTwoSided 

two sided

CapOptionsSymmetric 

symmetric

Method used to create the support feature.

Enumerator:
CreationMethodTwoPlanesandLines 

two planesand lines

CreationMethodSpecifyLine 

specify line

CreationMethodSpecifyCsys 

specify csys


Member Function Documentation

Returns the angle tolerance.


Created in NX8.0.0.

License requirements : None

Returns the angle that the pillar stock will be rotated about its path from its initial location.


Created in NX8.0.0.

License requirements : None

Returns the coord system (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation method).


Created in NX8.0.0.

License requirements : None

Returns the distance tolerance.


Created in NX8.0.0.

License requirements : None

Returns the list of available material attributes.


Created in NX8.0.0.

License requirements : None

Returns the end cap thickness.


Created in NX8.0.0.

License requirements : None

Returns the offset used to determine where the support ends (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : None

Returns the end plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the select guide curve (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" creation method).


Created in NX8.0.0.

License requirements : None

Returns the first line (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the second line (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the stock used to build the pillar from.


Created in NX8.0.0.

License requirements : None

Returns the orientation line (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" creation method).


Created in NX8.0.0.

License requirements : None

Returns the placement method used to locate the pillar.


Created in NX8.0.0.

License requirements : None

Returns the reverse end offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : None

Returns the reverse first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the reverse second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the reverse start offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : None

Sets the angle tolerance.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
angleToleranceangletolerance

Sets the coord system (only used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation method).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
coordSystemcoordsystem

Sets the distance tolerance.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
distanceTolerancedistancetolerance

Sets the end plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
endPlaneendplane

Sets the placement method used to locate the pillar.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
placementMethodplacementmethod

Sets the reverse end offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
reverseEndOffsetreverseendoffset

Sets the reverse first line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
reverseLine1Offsetreverseline1offset

Sets the reverse second line offset (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
reverseLine2Offsetreverseline2offset

Sets the reverse start offset (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
reverseStartOffsetreversestartoffset

Sets the start plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
startPlanestartplane

Sets the support cap options.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters:
supportCapOptionssupportcapoptions

Returns the list of available material attributes.


Created in NX8.0.0.

License requirements : None

Returns the start cap thickness.


Created in NX8.0.0.

License requirements : None

Returns the offset used to determine where the support starts (used with "JA_PILLAR_BUILDER_CreationMethod_SpecifyLine" and "JA_PILLAR_BUILDER_CreationMethod_SpecifyCsys" creation methods).


Created in NX8.0.0.

License requirements : None

Returns the start plane (only used with "JA_PILLAR_BUILDER_CreationMethod_TwoPlanesandLines" creation method).


Created in NX8.0.0.

License requirements : None

Returns the support cap options.


Created in NX8.0.0.

License requirements : None


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