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

Inheritance diagram for NXOpen::Features::ShipDesign::ShellTemplateBuilder:

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::CoordinateSystem *	CoordinateSystem ()
	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::Expression *	EndXTemplateOffset ()
	Returns the expression defining the value of the end offset of the template for set 1 (X).

NXOpen::Expression *	EndYTemplateOffset ()
	Returns the expression defining the value of the end offset of the template for set 2 (Y).

NXOpen::SelectIBasePlaneList *	PlaneAutomatic ()
	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::Plane *	SpecifyXPlane ()
	Returns the plane specifying the X direction for the coordinate system.

NXOpen::Plane *	SpecifyYPlane ()
	Returns the plane specifying the Y direction for the coordinate system.

NXOpen::Expression *	StartXTemplateOffset ()
	Returns the expression defining the value of the start offset of the template for set 1 (X).

NXOpen::Expression *	StartYTemplateOffset ()
	Returns the expression defining the value of the start offset of the template for set 2 (Y).

NXOpen::ScCollector *	Surface ()
	Returns the surface that the templates will be built to.

NXOpen::Expression *	Thickness ()
	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::Expression *	XOffset ()
	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::Expression *	YOffset ()
	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.

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature.

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder.

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited.

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1.

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1.

void	SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the parent features which would be internal or slaves to the feature being created or commited Created in NX6.0.0.

void	SetParentFeatureInternal (bool isInternal)
	Sets whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1.

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited.

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1.

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes

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.

enum NXOpen::Features::ShipDesign::ShellTemplateBuilder::Types

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

double NXOpen::Features::ShipDesign::ShellTemplateBuilder::AngleTolerance ( )

Returns the modeling angle tolerance.

Created in NX8.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Features::ShipDesign::ShellTemplateBuilder::CoordinateSystem ( )

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

double NXOpen::Features::ShipDesign::ShellTemplateBuilder::DistanceTolerance ( )

Returns the modeling distance tolerance.

Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::EndXTemplateOffset ( )

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

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::EndYTemplateOffset ( )

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

NXOpen::SelectIBasePlaneList* NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneAutomatic ( )

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

NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneLocationTypes NXOpen::Features::ShipDesign::ShellTemplateBuilder::PlaneMethod ( )

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

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetAngleTolerance ( double angleTolerance )

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

angleTolerance angletolerance

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetCoordinateSystem ( NXOpen::CoordinateSystem * coordinateSystem )

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

coordinateSystem coordinatesystem

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetDistanceTolerance ( double distanceTolerance )

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

distanceTolerance distancetolerance

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::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).

Created in NX8.0.0.

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

Parameters

planeMethod planemethod

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetSpecifyXPlane ( NXOpen::Plane * specifyXPlane )

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

specifyXPlane specifyxplane

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetSpecifyYPlane ( NXOpen::Plane * specifyYPlane )

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

specifyYPlane specifyyplane

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetType ( NXOpen::Features::ShipDesign::ShellTemplateBuilder::Types type )

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

type type

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetXPlaneUserDefined ( bool xPlaneUserDefined )

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

xPlaneUserDefined xplaneuserdefined

void NXOpen::Features::ShipDesign::ShellTemplateBuilder::SetYPlaneUserDefined ( bool yPlaneUserDefined )

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

yPlaneUserDefined yplaneuserdefined

NXOpen::Plane* NXOpen::Features::ShipDesign::ShellTemplateBuilder::SpecifyXPlane ( )

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

Created in NX8.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::ShellTemplateBuilder::SpecifyYPlane ( )

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

Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::StartXTemplateOffset ( )

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

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::StartYTemplateOffset ( )

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

NXOpen::ScCollector* NXOpen::Features::ShipDesign::ShellTemplateBuilder::Surface ( )

Returns the surface that the templates will be built to.

Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::Thickness ( )

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

Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ShellTemplateBuilder::Types NXOpen::Features::ShipDesign::ShellTemplateBuilder::Type ( )

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

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

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::XOffset ( )

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

Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShellTemplateBuilder::XPlaneUserDefined ( )

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

Created in NX8.0.1.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ShellTemplateBuilder::YOffset ( )

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

Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShellTemplateBuilder::YPlaneUserDefined ( )

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:

Features_ShipDesign_ShellTemplateBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation