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

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

Created in NX5.0.0. More...

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

Public Types

enum  OutputTypes { OutputTypesProfileList, OutputTypesXMLOut, OutputTypesAll }
 Used to specify the desired output. More...
 

Public Member Functions

NXOpen::SelectDisplayableObjectComponent ()
 Returns the component to preview
Created in NX11.0.0. More...
 
NXString CuttingInterfaceConfigFile ()
 Returns the Cutting Interface configuration file
Created in NX11.0.0. More...
 
NXString CuttingInterfaceOutputFile ()
 Returns the Cutting Interface output XML file
Created in NX11.0.0. More...
 
bool InverseBending ()
 Returns whether to include inverse bending data in the spreadsheet
Created in NX5.0.0. More...
 
bool KnuckledProfile ()
 Returns whether to include knuckled profile data in the spreadsheet
Created in NX11.0.0. More...
 
NXString ListFile ()
 Returns the spreadsheet
Created in NX5.0.0. More...
 
NXOpen::Assemblies::SelectComponentManufacturingCollector ()
 Returns the components of this part that contain a profile will be processed. More...
 
NXOpen::Features::ShipDesign::ProfileListBuilder::OutputTypes OutputType ()
 Returns the output type: Spreadsheet or XML
Created in NX11.0.0. More...
 
NXOpen::Assemblies::SelectComponentListPartSet ()
 Returns the profile components to process
Created in NX11.0.0. More...
 
void SetCuttingInterfaceConfigFile (const NXString &fileName)
 Sets the Cutting Interface configuration file
Created in NX11.0.0. More...
 
void SetCuttingInterfaceConfigFile (const char *fileName)
 Sets the Cutting Interface configuration file
Created in NX11.0.0. More...
 
void SetCuttingInterfaceOutputFile (const NXString &fileName)
 Sets the Cutting Interface output XML file
Created in NX11.0.0. More...
 
void SetCuttingInterfaceOutputFile (const char *fileName)
 Sets the Cutting Interface output XML file
Created in NX11.0.0. More...
 
void SetInverseBending (bool inverseBending)
 Sets whether to include inverse bending data in the spreadsheet
Created in NX5.0.0. More...
 
void SetKnuckledProfile (bool knuckledProfile)
 Sets whether to include knuckled profile data in the spreadsheet
Created in NX11.0.0. More...
 
void SetListFile (const NXString &listFile)
 Sets the spreadsheet
Created in NX5.0.0. More...
 
void SetListFile (const char *listFile)
 Sets the spreadsheet
Created in NX5.0.0. More...
 
void SetOutputType (NXOpen::Features::ShipDesign::ProfileListBuilder::OutputTypes outputType)
 Sets the output type: Spreadsheet or XML
Created in NX11.0.0. More...
 
void SetVentilationHoles (bool ventilationHoles)
 Sets whether to include ventilation hole data in the spreadsheet
Created in NX5.0.0. More...
 
bool VentilationHoles ()
 Returns whether to include ventilation hole data in the spreadsheet
Created in NX5.0.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::ProfileList builder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateProfileListBuilder

Created in NX5.0.0.


Member Enumeration Documentation

Used to specify the desired output.

Enumerator
OutputTypesProfileList 

profile list

OutputTypesXMLOut 

xmlout

OutputTypesAll 

all

Member Function Documentation

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::ProfileListBuilder::Component ( )

Returns the component to preview
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::ProfileListBuilder::CuttingInterfaceConfigFile ( )

Returns the Cutting Interface configuration file
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::ProfileListBuilder::CuttingInterfaceOutputFile ( )

Returns the Cutting Interface output XML file
Created in NX11.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::ProfileListBuilder::InverseBending ( )

Returns whether to include inverse bending data in the spreadsheet
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::ProfileListBuilder::KnuckledProfile ( )

Returns whether to include knuckled profile data in the spreadsheet
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::ProfileListBuilder::ListFile ( )

Returns the spreadsheet
Created in NX5.0.0.



License requirements : None

NXOpen::Assemblies::SelectComponent* NXOpen::Features::ShipDesign::ProfileListBuilder::ManufacturingCollector ( )

Returns the components of this part that contain a profile will be processed.


Created in NX11.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ProfileListBuilder::OutputTypes NXOpen::Features::ShipDesign::ProfileListBuilder::OutputType ( )

Returns the output type: Spreadsheet or XML
Created in NX11.0.0.



License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Features::ShipDesign::ProfileListBuilder::PartSet ( )

Returns the profile components to process
Created in NX11.0.0.



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

void NXOpen::Features::ShipDesign::ProfileListBuilder::SetCuttingInterfaceConfigFile ( const NXString fileName)

Sets the Cutting Interface configuration file
Created in NX11.0.0.



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

Parameters
fileNamefilename
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetCuttingInterfaceConfigFile ( const char *  fileName)

Sets the Cutting Interface configuration file
Created in NX11.0.0.



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

Parameters
fileNamefilename
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetCuttingInterfaceOutputFile ( const NXString fileName)

Sets the Cutting Interface output XML file
Created in NX11.0.0.



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

Parameters
fileNamefilename
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetCuttingInterfaceOutputFile ( const char *  fileName)

Sets the Cutting Interface output XML file
Created in NX11.0.0.



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

Parameters
fileNamefilename
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetInverseBending ( bool  inverseBending)

Sets whether to include inverse bending data in the spreadsheet
Created in NX5.0.0.



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

Parameters
inverseBendinginversebending
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetKnuckledProfile ( bool  knuckledProfile)

Sets whether to include knuckled profile data in the spreadsheet
Created in NX11.0.0.



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

Parameters
knuckledProfileknuckledprofile
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetListFile ( const NXString listFile)

Sets the spreadsheet
Created in NX5.0.0.



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

Parameters
listFilelistfile
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetListFile ( const char *  listFile)

Sets the spreadsheet
Created in NX5.0.0.



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

Parameters
listFilelistfile
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetOutputType ( NXOpen::Features::ShipDesign::ProfileListBuilder::OutputTypes  outputType)

Sets the output type: Spreadsheet or XML
Created in NX11.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
outputTypeoutputtype
void NXOpen::Features::ShipDesign::ProfileListBuilder::SetVentilationHoles ( bool  ventilationHoles)

Sets whether to include ventilation hole data in the spreadsheet
Created in NX5.0.0.



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

Parameters
ventilationHolesventilationholes
bool NXOpen::Features::ShipDesign::ProfileListBuilder::VentilationHoles ( )

Returns whether to include ventilation hole data in the spreadsheet
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.