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

Represents a NXOpen::Features::ShipDesign::InsertFramesBuilder builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateInsertFramesBuilder

Created in NX5.0.0. More...

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

Public Types

enum  Types { TypesTransverse, TypesLongitudnalZ, TypesLongitudnalY }
 Represents the Insert Frame Builder type. More...
 

Public Member Functions

void SetStartFrameName (const NXString &frameName)
 Sets the Transverse Frame name
Created in NX5.0.0. More...
 
void SetStartFrameName (const char *frameName)
 Sets the Transverse Frame name
Created in NX5.0.0. More...
 
void SetType (NXOpen::Features::ShipDesign::InsertFramesBuilder::Types type)
 Sets the type
Created in NX5.0.0. More...
 
NXString StartFrameName ()
 Returns the Transverse Frame name
Created in NX5.0.0. More...
 
NXOpen::Features::ShipDesign::InsertFramesBuilder::Types Type ()
 Returns the type
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::ShipDesign::TransFrameBuilder
NXString AttribName ()
 Returns the attribute for name type. More...
 
NXString AttribRef ()
 Returns the attribute for reference type. More...
 
NXOpen::Features::ShipDesign::TransFrameListItemBuilderCreateTransFrameListItem ()
 Create a list containing all required info to generate transverse frame. More...
 
NXString FeatureNameSuffix ()
 Returns the suffix name. More...
 
int NegateFrame ()
 Returns the reverse index since where frames turn to opposite. More...
 
void SetAttribName (const NXString &attribName)
 Sets the attribute for name type. More...
 
void SetAttribName (const char *attribName)
 Sets the attribute for name type. More...
 
void SetAttribRef (const NXString &attribRef)
 Sets the attribute for reference type. More...
 
void SetAttribRef (const char *attribRef)
 Sets the attribute for reference type. More...
 
void SetFeatureNameSuffix (const NXString &featureNameSuffix)
 Sets the suffix name. More...
 
void SetFeatureNameSuffix (const char *featureNameSuffix)
 Sets the suffix name. More...
 
void SetNegateFrame (int negateFrame)
 Sets the reverse index since where frames turn to opposite. More...
 
NXOpen::Features::ShipDesign::TransFrameListItemBuilderListTransFrameNegList ()
 Returns the negative list. More...
 
NXOpen::Features::ShipDesign::TransFrameListItemBuilderListTransFramePosList ()
 Returns the positive list. 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::InsertFramesBuilder builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateInsertFramesBuilder

Created in NX5.0.0.


Member Enumeration Documentation

Represents the Insert Frame Builder type.

Enumerator
TypesTransverse 

transverse

TypesLongitudnalZ 

longitudnal z

TypesLongitudnalY 

longitudnal y

Member Function Documentation

void NXOpen::Features::ShipDesign::InsertFramesBuilder::SetStartFrameName ( const NXString frameName)

Sets the Transverse Frame name
Created in NX5.0.0.



License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
frameNameframename
void NXOpen::Features::ShipDesign::InsertFramesBuilder::SetStartFrameName ( const char *  frameName)

Sets the Transverse Frame name
Created in NX5.0.0.



License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
frameNameframename
void NXOpen::Features::ShipDesign::InsertFramesBuilder::SetType ( NXOpen::Features::ShipDesign::InsertFramesBuilder::Types  type)

Sets the type
Created in NX5.0.0.



License requirements : nx_ship_concept ("Ship Concept") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
typetype
NXString NXOpen::Features::ShipDesign::InsertFramesBuilder::StartFrameName ( )

Returns the Transverse Frame name
Created in NX5.0.0.



License requirements : None

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

Returns the type
Created in NX5.0.0.



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.