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

Represents a NXOpen::Features::ShipDesign::ExcessMaterial builder. More...

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

Public Types

enum  Offset { OffsetConstant, OffsetLinearVarying }
 The offset type (only applicable for excess material, fitup will ignore the offset type) More...
 
enum  Types { TypesExcessMaterial, TypesFitUp }
 The feature type. More...
 
enum  VersionID { VersionIDOriginal, VersionIDNx902 }
 version identifiers for the different revisions of the excess material feature. More...
 

Public Member Functions

NXOpen::ExpressionEndOffset ()
 Returns the end offset (only applicable for excess material with variable offsets, fitup and constant offset excess material will ignore this value)
Created in NX9.0.2. More...
 
bool ExtendEndFace ()
 Returns the extend end side face option (not applicable for fitup)
Created in NX9.0.2. More...
 
bool ExtendStartFace ()
 Returns the extend start side face option (not applicable for fitup)
Created in NX9.0.2. More...
 
NXOpen::ExpressionOffsetDistance ()
 Returns the offset distance
More...
 
NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Offset OffsetType ()
 Returns the offset type (only applicable for excess material, fitup will ignore the offset type)
Created in NX9.0.2. More...
 
NXOpen::SelectFaceSelectFace ()
 Returns the selection face. More...
 
NXOpen::ScCollectorSelectFaces ()
 Returns the faces that need to have excess material. More...
 
void SetExtendEndFace (bool extendEndFace)
 Sets the extend end side face option (not applicable for fitup)
Created in NX9.0.2. More...
 
void SetExtendStartFace (bool extendStartFace)
 Sets the extend start side face option (not applicable for fitup)
Created in NX9.0.2. More...
 
void SetOffsetType (NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Offset offsetType)
 Sets the offset type (only applicable for excess material, fitup will ignore the offset type)
Created in NX9.0.2. More...
 
void SetType (NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Types type)
 Sets the feature type (ie excess material or fitup)
Created in NX9.0.2. More...
 
NXOpen::ExpressionStartOffset ()
 Returns the start offset (replaces the legacy offset distance property, and is used for both excess material and fitup)
Created in NX9.0.2. More...
 
NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Types Type ()
 Returns the feature type (ie excess material or fitup)
Created in NX9.0.2. More...
 
NXOpen::Features::ShipDesign::ExcessMaterialBuilder::VersionID Version ()
 Returns the version of the feature (used to determine which properties and methods are applicable) during edit. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
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. More...
 
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. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Represents a NXOpen::Features::ShipDesign::ExcessMaterial builder.

The Excess Material feature adds excess manufacturing material to the end of plate.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateExcessMaterialBuilder
Default values.

Property Value

EndOffset.Value

10 (millimeters part), 10 (inches part)

ExtendEndFace

0

ExtendStartFace

0

OffsetDistance.Value (deprecated)

10 (millimeters part), 10 (inches part)

OffsetType

Constant

StartOffset.Value

10 (millimeters part), 10 (inches part)


Created in NX7.5.0.

Member Enumeration Documentation

The offset type (only applicable for excess material, fitup will ignore the offset type)

Enumerator
OffsetConstant 

constant offset

OffsetLinearVarying 

linear varying

The feature type.

Enumerator
TypesExcessMaterial 

excess material placement method

TypesFitUp 

fit up placement method (added in NX902)

version identifiers for the different revisions of the excess material feature.

Enumerator
VersionIDOriginal 

This feature builder is used to edit an existing NX75 - NX901 excess material feature.

VersionIDNx902 

This feature builder is used to create or edit an NX902 or beyond feature.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::ShipDesign::ExcessMaterialBuilder::EndOffset ( )

Returns the end offset (only applicable for excess material with variable offsets, fitup and constant offset excess material will ignore this value)
Created in NX9.0.2.



License requirements : None

bool NXOpen::Features::ShipDesign::ExcessMaterialBuilder::ExtendEndFace ( )

Returns the extend end side face option (not applicable for fitup)
Created in NX9.0.2.



License requirements : None

bool NXOpen::Features::ShipDesign::ExcessMaterialBuilder::ExtendStartFace ( )

Returns the extend start side face option (not applicable for fitup)
Created in NX9.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::ExcessMaterialBuilder::OffsetDistance ( )

Returns the offset distance

Deprecated:
Deprecated in NX9.0.2.

Use NXOpen::Features::ShipDesign::ExcessMaterialBuilder::StartOffset instead.


Created in NX7.5.0.

License requirements : None

NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Offset NXOpen::Features::ShipDesign::ExcessMaterialBuilder::OffsetType ( )

Returns the offset type (only applicable for excess material, fitup will ignore the offset type)
Created in NX9.0.2.



License requirements : None

NXOpen::SelectFace* NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SelectFace ( )

Returns the selection face.

The selected face will be offset by the specified distance.

Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SelectFaces instead.


Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SelectFaces ( )

Returns the faces that need to have excess material.


Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SetExtendEndFace ( bool  extendEndFace)

Sets the extend end side face option (not applicable for fitup)
Created in NX9.0.2.



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

Parameters
extendEndFaceextendendface
void NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SetExtendStartFace ( bool  extendStartFace)

Sets the extend start side face option (not applicable for fitup)
Created in NX9.0.2.



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

Parameters
extendStartFaceextendstartface
void NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SetOffsetType ( NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Offset  offsetType)

Sets the offset type (only applicable for excess material, fitup will ignore the offset type)
Created in NX9.0.2.



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

Parameters
offsetTypeoffsettype
void NXOpen::Features::ShipDesign::ExcessMaterialBuilder::SetType ( NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Types  type)

Sets the feature type (ie excess material or fitup)
Created in NX9.0.2.



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

Parameters
typetype
NXOpen::Expression* NXOpen::Features::ShipDesign::ExcessMaterialBuilder::StartOffset ( )

Returns the start offset (replaces the legacy offset distance property, and is used for both excess material and fitup)
Created in NX9.0.2.



License requirements : None

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

Returns the feature type (ie excess material or fitup)
Created in NX9.0.2.



License requirements : None

NXOpen::Features::ShipDesign::ExcessMaterialBuilder::VersionID NXOpen::Features::ShipDesign::ExcessMaterialBuilder::Version ( )

Returns the version of the feature (used to determine which properties and methods are applicable) during edit.

The version of new features during create will be NX902
Created in NX9.0.2.

License requirements : None


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