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

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

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

Public Types

enum  ShipLibAssemblyOption { ShipLibAssemblyOptionWorkPart, ShipLibAssemblyOptionWorkPartandComponents, ShipLibAssemblyOptionWorkPartandComponentswithLibraries }
 Assembly update library options. More...
 
enum  ShipLibOptionType {
  ShipLibOptionTypeProfile, ShipLibOptionTypeBelt, ShipLibOptionTypeCutout, ShipLibOptionTypeEndcut,
  ShipLibOptionTypeSupport, ShipLibOptionTypeSupportCap, ShipLibOptionTypeWeldOnEdge, ShipLibOptionTypeBracket,
  ShipLibOptionTypeWeldAlongEdge
}
 Ship Library Types Note the weld along edge option is no longer used in NX7.5, and will be removed in NX8. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibAssemblyOption AssemblyOptions ()
 Returns the assembly scope options. More...
 
NXString FileBrowser ()
 Returns the file browser
Created in NX5.3.0. More...
 
void SetAssemblyOptions (NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibAssemblyOption assemblyOptions)
 Sets the assembly scope options. More...
 
void SetFileBrowser (const NXString &filename)
 Sets the file browser
Created in NX5.3.0. More...
 
void SetFileBrowser (const char *filename)
 Sets the file browser
Created in NX5.3.0. More...
 
void SetShipLibType (NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibOptionType shipLibType)
 Sets the ship lib type
Created in NX5.3.0. More...
 
NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibOptionType ShipLibType ()
 Returns the ship lib type
Created in NX5.3.0. 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::UpdateShipLibrary builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateUpdateShipLibraryBuilder
Default values.

Property Value

AssemblyOptions

WorkPart

ShipLibType

Profile


Created in NX5.3.0.

Member Enumeration Documentation

Assembly update library options.

Enumerator
ShipLibAssemblyOptionWorkPart 

update the library in the current work part only

ShipLibAssemblyOptionWorkPartandComponents 

update the library in the current work part and all of its components

ShipLibAssemblyOptionWorkPartandComponentswithLibraries 

update any parts with existing libraries starting in the current work part and all of its components

Ship Library Types Note the weld along edge option is no longer used in NX7.5, and will be removed in NX8.

Enumerator
ShipLibOptionTypeProfile 

profile

ShipLibOptionTypeBelt 

belt

ShipLibOptionTypeCutout 

cutout

ShipLibOptionTypeEndcut 

endcut

ShipLibOptionTypeSupport 

support

ShipLibOptionTypeSupportCap 

support cap

ShipLibOptionTypeWeldOnEdge 

weld on edge

ShipLibOptionTypeBracket 

bracket

ShipLibOptionTypeWeldAlongEdge 

obsolete in NX7.5

Member Function Documentation

NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibAssemblyOption NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::AssemblyOptions ( )

Returns the assembly scope options.


Created in NX7.5.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::FileBrowser ( )

Returns the file browser
Created in NX5.3.0.



License requirements : None

void NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::SetAssemblyOptions ( NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibAssemblyOption  assemblyOptions)

Sets the assembly scope options.


Created in NX7.5.0.

License requirements : nx_ship_concept ("Ship Concept")

Parameters
assemblyOptionsassemblyoptions
void NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::SetFileBrowser ( const NXString filename)

Sets the file browser
Created in NX5.3.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
filenamefilename
void NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::SetFileBrowser ( const char *  filename)

Sets the file browser
Created in NX5.3.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
filenamefilename
void NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::SetShipLibType ( NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibOptionType  shipLibType)

Sets the ship lib type
Created in NX5.3.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
shipLibTypeshiplibtype
NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibOptionType NXOpen::Features::ShipDesign::UpdateShipLibraryBuilder::ShipLibType ( )

Returns the ship lib type
Created in NX5.3.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.