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

Used to edit or create a Features::ShipDesign::ShellTemplate feature. More...

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

List of all members.

Public Types

enum  PlaneLocationTypes { PlaneLocationTypesExisting, PlaneLocationTypesOffset }
 The option for how the plane locations will be specified as input. More...
enum  Types { TypesManual, TypesInferCoordinateSystem }
 The option for controlling how the coordinate system for template creation is specified. More...

Public Member Functions

double AngleTolerance ()
 Returns the modeling angle tolerance.
NXOpen::CoordinateSystemCoordinateSystem ()
 Returns the coordinate system defining the origin as well as the X and Y axis for the templates.
double DistanceTolerance ()
 Returns the modeling distance tolerance.
NXOpen::ExpressionEndXTemplateOffset ()
 Returns the expression defining the value of the end offset of the template for set 1 (X).
NXOpen::ExpressionEndYTemplateOffset ()
 Returns the expression defining the value of the end offset of the template for set 2 (Y).
NXOpen::SelectIBasePlaneListPlaneAutomatic ()
 Returns the planes specifying both the X and Y orientations of the templates.
NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes PlaneMethod ()
 Returns the value identifying how the planes (used for sections) will be specified (See Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes for the plane methods).
void SetAngleTolerance (double angleTolerance)
 Sets the modeling angle tolerance.
void SetCoordinateSystem (NXOpen::CoordinateSystem *coordinateSystem)
 Sets the coordinate system defining the origin as well as the X and Y axis for the templates.
void SetDistanceTolerance (double distanceTolerance)
 Sets the modeling distance tolerance.
void SetPlaneMethod (NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes planeMethod)
 Sets the value identifying how the planes (used for sections) will be specified (See Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes for the plane methods).
void SetSpecifyXPlane (NXOpen::Plane *specifyXPlane)
 Sets the plane specifying the X direction for the coordinate system.
void SetSpecifyYPlane (NXOpen::Plane *specifyYPlane)
 Sets the plane specifying the Y direction for the coordinate system.
void SetType (NXOpen::Features::ShipDesign::ShellTemplateBuilder::Types type)
 Sets the value defining how the coordinate system will be defined.
void SetXPlaneUserDefined (bool xPlaneUserDefined)
 Sets the value specifying that the plane for the X direction was user defined.
void SetYPlaneUserDefined (bool yPlaneUserDefined)
 Sets the value specifying that the plane for the Y direction was user defined.
NXOpen::PlaneSpecifyXPlane ()
 Returns the plane specifying the X direction for the coordinate system.
NXOpen::PlaneSpecifyYPlane ()
 Returns the plane specifying the Y direction for the coordinate system.
NXOpen::ExpressionStartXTemplateOffset ()
 Returns the expression defining the value of the start offset of the template for set 1 (X).
NXOpen::ExpressionStartYTemplateOffset ()
 Returns the expression defining the value of the start offset of the template for set 2 (Y).
NXOpen::ScCollectorSurface ()
 Returns the surface that the templates will be built to.
NXOpen::ExpressionThickness ()
 Returns the expression defining the value of the thickness of the template.
NXOpen::Features::ShipDesign::ShellTemplateBuilder::Types Type ()
 Returns the value defining how the coordinate system will be defined.
NXOpen::ExpressionXOffset ()
 Returns the expression defining the value of the offset to apply in the X direction.
bool XPlaneUserDefined ()
 Returns the value specifying that the plane for the X direction was user defined.
NXOpen::ExpressionYOffset ()
 Returns the expression defining the value of the offset to apply in the Y direction.
bool YPlaneUserDefined ()
 Returns the value specifying that the plane for the Y direction was user defined.

Detailed Description

Used to edit or create a Features::ShipDesign::ShellTemplate feature.

The shell templates are defined on a surface by specifying a primary orientation coordinate system. The orientation coordinate system is then used to build, or filter, planes used to locate each individual template. There are 2 primary methods for defining the input. Manual allows for specific, selected, data to limit various aspects of the build (for example, build with only 1 plane). Inferred allows for the tools to generate data, thus building with a minimal of predefined input data.
To create a new instance of this class, use Features::ShipCollection::CreateShellTemplateBuilder
Default values.

Property Value

EndXTemplateOffset.Value

0 (millimeters part), 0 (inches part)

EndYTemplateOffset.Value

0 (millimeters part), 0 (inches part)

PlaneMethod

Existing

StartXTemplateOffset.Value

0 (millimeters part), 0 (inches part)

StartYTemplateOffset.Value

0 (millimeters part), 0 (inches part)

Thickness.Value

0 (millimeters part), 0 (inches part)

XOffset.Value

300.0 (millimeters part), 12.0 (inches part)

YOffset.Value

300.0 (millimeters part), 12.0 (inches part)


Created in NX8.0.0.


Member Enumeration Documentation

The option for how the plane locations will be specified as input.

Enumerator:
PlaneLocationTypesExisting 

Use existing planes to define the individual template locations.

PlaneLocationTypesOffset 

Derive the plane locations from the orientation coordinate system or X and Y specified base planes.

The option for controlling how the coordinate system for template creation is specified.

Enumerator:
TypesManual 

Manually specify the coordinate system.

TypesInferCoordinateSystem 

Derive the coordinate system.


Member Function Documentation

Returns the modeling angle tolerance.


Created in NX8.0.0.

License requirements : None

Returns the coordinate system defining the origin as well as the X and Y axis for the templates.


Created in NX8.0.0.

License requirements : None

Returns the modeling distance tolerance.


Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the end offset of the template for set 1 (X).


Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the end offset of the template for set 2 (Y).


Created in NX8.0.0.

License requirements : None

Returns the planes specifying both the X and Y orientations of the templates.

They will automatically be separated, or grouped, for X and Y as needed. This is only valid when Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes is Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypesExisting .
Created in NX8.0.0.

License requirements : None

Returns the value identifying how the planes (used for sections) will be specified (See Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes for the plane methods).


Created in NX8.0.0.

License requirements : None

Sets the modeling angle tolerance.


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
angleToleranceangletolerance

Sets the coordinate system defining the origin as well as the X and Y axis for the templates.


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
coordinateSystemcoordinatesystem

Sets the modeling distance tolerance.


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
distanceTolerancedistancetolerance

Sets the value identifying how the planes (used for sections) will be specified (See Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes for the plane methods).


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
planeMethodplanemethod

Sets the plane specifying the X direction for the coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
specifyXPlanespecifyxplane

Sets the plane specifying the Y direction for the coordinate system.


Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
specifyYPlanespecifyyplane

Sets the value defining how the coordinate system will be defined.

See Features::ShipDesign::ShellTemplateBuilder::Types .
Created in NX8.0.0.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
typetype

Sets the value specifying that the plane for the X direction was user defined.


Created in NX8.0.1.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
xPlaneUserDefinedxplaneuserdefined

Sets the value specifying that the plane for the Y direction was user defined.


Created in NX8.0.1.

License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters:
yPlaneUserDefinedyplaneuserdefined

Returns the plane specifying the X direction for the coordinate system.


Created in NX8.0.0.

License requirements : None

Returns the plane specifying the Y direction for the coordinate system.


Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the start offset of the template for set 1 (X).


Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the start offset of the template for set 2 (Y).


Created in NX8.0.0.

License requirements : None

Returns the surface that the templates will be built to.


Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the thickness of the template.


Created in NX8.0.0.

License requirements : None

Returns the value defining how the coordinate system will be defined.

See Features::ShipDesign::ShellTemplateBuilder::Types .
Created in NX8.0.0.

License requirements : None

Returns the expression defining the value of the offset to apply in the X direction.


Created in NX8.0.0.

License requirements : None

Returns the value specifying that the plane for the X direction was user defined.


Created in NX8.0.1.

License requirements : None

Returns the expression defining the value of the offset to apply in the Y direction.


Created in NX8.0.0.

License requirements : None

Returns the value specifying that the plane for the Y direction was user defined.


Created in NX8.0.1.

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.