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

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

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

List of all members.

Public Types

enum  CapOptions { CapOptionsNone, CapOptionsTwoSided, CapOptionsSymmetric }
 Does this feature have end caps, and if so what kind? More...
enum  CreationMethod { CreationMethodTwoPlanesandLines, CreationMethodSpecifyLine, CreationMethodSpecifyCsys }
 Method used to create the support feature. More...

Public Member Functions

NXOpen::ExpressionAngularDim ()
 Returns the angular dimension used to rotate the support feature.
int AttributeMaterial ()
 Returns the attribute material
Created in NX7.5.0.
int AttributeName ()
 Returns the name attribute value
Created in NX7.5.0.
NXOpen::CoordinateSystemCoordSystem ()
 Returns the coord system (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.
int EndCapSize ()
 Returns the end cap size.
NXOpen::ExpressionEndCapThickness ()
 Returns the end cap thickness
Created in NX7.5.0.
int EndCapType ()
 Returns the end cap type.
NXOpen::ExpressionEndOffset ()
 Returns the offset used to determine where the support ends (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
NXOpen::PlaneEndPlane ()
 Returns the end plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
std::vector< NXStringGetAvailableAttributeMaterials ()
 Returns the list of available material attributes.
std::vector< NXStringGetAvailableAttributeNames ()
 Returns the list of available name attributes.
std::vector< NXStringGetAvailableCapTypes ()
 The list of available start and end cap types.
std::vector< NXStringGetAvailableEndCapSizes ()
 The list of available end cap sizes.
std::vector< NXStringGetAvailableStartCapSizes ()
 The list of available start cap sizes.
std::vector< NXStringGetAvailableSupportSizes ()
 The list of available sizes.
std::vector< NXStringGetAvailableSupportTypes ()
 The list of available support types.
bool KeepCoordSystem ()
 Returns whether or not we should keep the selected csys on apply (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.
bool KeepEndPlane ()
 Returns whether or not we should keep the selected end plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool KeepReverseEndOffset ()
 Returns the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
bool KeepReverseLine1Offset ()
 Returns the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool KeepReverseLine2Offset ()
 Returns the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool KeepReverseStartOffset ()
 Returns the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
bool KeepSelectGuideCurve ()
 Returns whether or not we should keep the selected guide curve on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
bool KeepSelectLine1 ()
 Returns whether or not we should keep the selected first line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool KeepSelectLine2 ()
 Returns whether or not we should keep the selected second line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool KeepSelectOrientationLine ()
 Returns whether or not we should keep the selected orientation line on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
bool KeepStartPlane ()
 Returns whether or not we should keep the selected start plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::ExpressionLine1Offset ()
 Returns the first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::ExpressionLine2Offset ()
 Returns the second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::Features::ShipDesign::SteelSupportBuilder::CreationMethod PlacementMethod ()
 Returns the placement method used to create the feature
Created in NX7.5.0.
bool ReverseEndOffset ()
 Returns the reverse end offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
bool ReverseLine1Offset ()
 Returns the reverse first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool ReverseLine2Offset ()
 Returns the reverse second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
bool ReverseStartOffset ()
 Returns the reverse start offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
NXOpen::SelectTaggedObjectSelectGuideCurve ()
 Returns the select guide curve (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
NXOpen::SelectTaggedObjectSelectLine1 ()
 Returns the first line (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::SelectTaggedObjectSelectLine2 ()
 Returns the second line (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::SelectTaggedObjectSelectOrientationLine ()
 Returns the orientation line (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
void SetAttributeMaterial (int attributeMaterial)
 Sets the attribute material
Created in NX7.5.0.
void SetAttributeName (int attributeName)
 Sets the name attribute value
Created in NX7.5.0.
void SetCoordSystem (NXOpen::CoordinateSystem *coordSystem)
 Sets the coord system (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.
void SetEndCapSize (int endCapSize)
 Sets the end cap size.
void SetEndCapType (int endCapType)
 Sets the end cap type.
void SetEndPlane (NXOpen::Plane *endPlane)
 Sets the end plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepCoordSystem (bool keepCoordSystem)
 Sets whether or not we should keep the selected csys on apply (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.
void SetKeepEndPlane (bool keepEndPlane)
 Sets whether or not we should keep the selected end plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepReverseEndOffset (bool keepReverseEndOffset)
 Sets the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
void SetKeepReverseLine1Offset (bool keepReverseLine1Offset)
 Sets the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepReverseLine2Offset (bool keepReverseLine2Offset)
 Sets the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepReverseStartOffset (bool keepReverseStartOffset)
 Sets the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
void SetKeepSelectGuideCurve (bool keepSelectGuideCurve)
 Sets whether or not we should keep the selected guide curve on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
void SetKeepSelectLine1 (bool keepSelectLine1)
 Sets whether or not we should keep the selected first line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepSelectLine2 (bool keepSelectLine2)
 Sets whether or not we should keep the selected second line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetKeepSelectOrientationLine (bool keepSelectOrientationLine)
 Sets whether or not we should keep the selected orientation line on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.
void SetKeepStartPlane (bool keepStartPlane)
 Sets whether or not we should keep the selected start plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetPlacementMethod (NXOpen::Features::ShipDesign::SteelSupportBuilder::CreationMethod placementMethod)
 Sets the placement method used to create the feature
Created in NX7.5.0.
void SetReverseEndOffset (bool reverseEndOffset)
 Sets the reverse end offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
void SetReverseLine1Offset (bool reverseLine1Offset)
 Sets the reverse first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetReverseLine2Offset (bool reverseLine2Offset)
 Sets the reverse second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetReverseStartOffset (bool reverseStartOffset)
 Sets the reverse start offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
void SetStartCapSize (int startCapSize)
 Sets the start cap size.
void SetStartCapType (int startCapType)
 Sets the start cap type.
void SetStartPlane (NXOpen::Plane *startPlane)
 Sets the start plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
void SetSupportCapOptions (NXOpen::Features::ShipDesign::SteelSupportBuilder::CapOptions supportCapOptions)
 Sets the support cap options
Created in NX7.5.0.
void SetSupportSize (int supportSize)
 Sets the support size.
void SetSupportType (int supportType)
 Sets the support type.
int StartCapSize ()
 Returns the start cap size.
NXOpen::ExpressionStartCapThickness ()
 Returns the start cap thickness
Created in NX7.5.0.
int StartCapType ()
 Returns the start cap type.
NXOpen::ExpressionStartOffset ()
 Returns the offset used to determine where the support starts (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.
NXOpen::PlaneStartPlane ()
 Returns the start plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.
NXOpen::Features::ShipDesign::SteelSupportBuilder::CapOptions SupportCapOptions ()
 Returns the support cap options
Created in NX7.5.0.
int SupportSize ()
 Returns the support size.
int SupportType ()
 Returns the support type.

Detailed Description

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

Property Value

AngularDim.Value

0

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 NX7.5.0.


Member Enumeration Documentation

Does this feature have end caps, and if so what kind?

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 angular dimension used to rotate the support feature.


Created in NX7.5.0.

License requirements : None

Returns the attribute material
Created in NX7.5.0.



License requirements : None

Returns the name attribute value
Created in NX7.5.0.



License requirements : None

Returns the coord system (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.



License requirements : None

Returns the end cap size.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : None

Returns the end cap thickness
Created in NX7.5.0.



License requirements : None

Returns the end cap type.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : None

Returns the offset used to determine where the support ends (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns the end plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

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

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

The list of available start and end cap types.

Returns:
Array of available cap types. These names are specified by a special sketch naming convention for sketches loaded in the support cap library.
Created in NX7.5.0.

License requirements : None

The list of available end cap sizes.

The available end cap sizes will change everytime the end cap type changes.

Returns:
Array of available end cap sizes. These names are specified by a special sketch naming convention for sketches loaded in the support cap library.
Created in NX7.5.0.

License requirements : None

The list of available start cap sizes.

The available start cap sizes will change everytime the start cap type changes.

Returns:
Array of available start cap sizes. These names are specified by a special sketch naming convention for sketches loaded in the support cap library.
Created in NX7.5.0.

License requirements : None

The list of available sizes.

The available sizes will change everytime the support type changes.

Returns:
Array of available sizes. These names are specified by a special sketch naming convention for sketches loaded in the support library.
Created in NX7.5.0.

License requirements : None

The list of available support types.

Returns:
Array of available types. These names are specified by a special sketch naming convention for sketches loaded in the support library.
Created in NX7.5.0.

License requirements : None

Returns whether or not we should keep the selected csys on apply (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected end plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected guide curve on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected first line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected second line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected orientation line on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : None

Returns whether or not we should keep the selected start plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the placement method used to create the feature
Created in NX7.5.0.



License requirements : None

Returns the reverse end offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns the reverse first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the reverse second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the reverse start offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns the select guide curve (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : None

Returns the first line (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the second line (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the orientation line (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : None

Sets the attribute material
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
attributeMaterialattributematerial

Sets the name attribute value
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
attributeNameattributename

Sets the coord system (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
coordSystemcoordsystem

Sets the end cap size.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
endCapSizeendcapsize

Sets the end cap type.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
endCapTypeendcaptype

Sets the end plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
endPlaneendplane

Sets whether or not we should keep the selected csys on apply (only used with "SpecifyCsys" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepCoordSystemkeepcoordsystem

Sets whether or not we should keep the selected end plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepEndPlanekeependplane

Sets the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepReverseEndOffsetkeepreverseendoffset

Sets the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepReverseLine1Offsetkeepreverseline1offset

Sets the keep previous reverse setting on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepReverseLine2Offsetkeepreverseline2offset

Sets the keep previous reverse setting on apply (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepReverseStartOffsetkeepreversestartoffset

Sets whether or not we should keep the selected guide curve on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepSelectGuideCurvekeepselectguidecurve

Sets whether or not we should keep the selected first line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepSelectLine1keepselectline1

Sets whether or not we should keep the selected second line on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepSelectLine2keepselectline2

Sets whether or not we should keep the selected orientation line on apply (only used with "SpecifyLine" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepSelectOrientationLinekeepselectorientationline

Sets whether or not we should keep the selected start plane on apply (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
keepStartPlanekeepstartplane

Sets the placement method used to create the feature
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
placementMethodplacementmethod

Sets the reverse end offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
reverseEndOffsetreverseendoffset

Sets the reverse first line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
reverseLine1Offsetreverseline1offset

Sets the reverse second line offset (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
reverseLine2Offsetreverseline2offset

Sets the reverse start offset (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
reverseStartOffsetreversestartoffset

Sets the start cap size.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
startCapSizestartcapsize

Sets the start cap type.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
startCapTypestartcaptype

Sets the start plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
startPlanestartplane

Sets the support cap options
Created in NX7.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters:
supportCapOptionssupportcapoptions

Sets the support size.

Determines the cross section of the support.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
supportSizesupportsize

Sets the support type.

Determines the cross section of the support.
Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters:
supportTypesupporttype

Returns the start cap size.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : None

Returns the start cap thickness
Created in NX7.5.0.



License requirements : None

Returns the start cap type.

Determines the cross section of the support cap.
Created in NX7.5.0.

License requirements : None

Returns the offset used to determine where the support starts (used with "SpecifyLine" and "SpecifyCsys" creation methods)
Created in NX7.5.0.



License requirements : None

Returns the start plane (only used with "TwoPlanesandLines" creation method)
Created in NX7.5.0.



License requirements : None

Returns the support cap options
Created in NX7.5.0.



License requirements : None

Returns the support size.

Determines the cross section of the support.
Created in NX7.5.0.

License requirements : None

Returns the support type.

Determines the cross section of the support.
Created in NX7.5.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.