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

Copy the selected parts (components) about the Mirror Plane with full model history and feature data. More...

Inheritance diagram for NXOpen::Features::ShipDesign::MirrorShipStructureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AppTypes { AppTypesShipDetailDesign, AppTypesShipBasicDesign }
 Settings to indicate the current application type. More...
 
enum  MirrorApproach { MirrorApproachCreateLinkedMirrorBody, MirrorApproachCopySourceFeaturesAndReparent }
 Represents the approach of mirroring ship standard parts. More...
 
enum  Types { TypesStructureSystem, TypesFeature }
 Settings to indicate the selection type of ship feature. More...
 

Public Member Functions

double AngularTolerance ()
 Returns the angular tolerance used for geometry comparison and defined in the customer defaults. More...
 
NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::AppTypes ApplicationType ()
 Returns the application type, which is ship basic design or ship detail design. More...
 
double LinearToleranceFactor ()
 Returns the linear tolerance factor used for the geometry comparison and defined in the customer default. More...
 
NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorApproach MirrorApproachOption ()
 Returns an option to determines the approach to copy and mirror ship standard parts. More...
 
NXOpen::PlaneMirrorPlane ()
 Returns the mirror plane. More...
 
NXOpen::Features::SelectFeatureListOriginalFeatures ()
 Returns the list of features to Mirror Copy. More...
 
NXOpen::Assemblies::SelectComponentListOriginalParts ()
 Returns the list of parts (or components) to Mirror Copy. More...
 
bool ReportMirrorResultXML ()
 Returns an XML report with mirror process information will be shown if set to true. More...
 
NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::Types SelectionType ()
 Returns the selection type, which is structure system or feature. More...
 
void SetAngularTolerance (double angularTolerance)
 Sets the angular tolerance used for geometry comparison and defined in the customer defaults. More...
 
void SetApplicationType (NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::AppTypes type)
 Sets the application type, which is ship basic design or ship detail design. More...
 
void SetLinearToleranceFactor (double linearToleranceFactor)
 Sets the linear tolerance factor used for the geometry comparison and defined in the customer default. More...
 
void SetMirrorApproachOption (NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorApproach mirrorApproachOption)
 Sets an option to determines the approach to copy and mirror ship standard parts. More...
 
void SetMirrorPlane (NXOpen::Plane *mirrorPlane)
 Sets the mirror plane. More...
 
void SetReportMirrorResultXML (bool reportMirrorResultXML)
 Sets an XML report with mirror process information will be shown if set to true. More...
 
void SetSelectionType (NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::Types type)
 Sets the selection type, which is structure system or feature. More...
 
int SortComponentByInterPartDependency (std::vector< NXString > &nonBreakableCircles, std::vector< NXString > &brokenCircles)
 Sort components by inter-part dependency and return dependency circles. More...
 
NXOpen::Assemblies::SelectComponentListTargetPart ()
 Returns the target parts or components where the selected features will be mirror copied into. 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

Copy the selected parts (components) about the Mirror Plane with full model history and feature data.


To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateMirrorShipStructureBuilder
Default values.

Property Value

ReportMirrorResultXML

1


Created in NX10.0.0.

Member Enumeration Documentation

Settings to indicate the current application type.

Enumerator
AppTypesShipDetailDesign 

The ship detail design.

AppTypesShipBasicDesign 

The ship basic design.

Represents the approach of mirroring ship standard parts.

Enumerator
MirrorApproachCreateLinkedMirrorBody 

The approach by creating linked mirror body.

MirrorApproachCopySourceFeaturesAndReparent 

The approach by copy source features and reparenting.

Settings to indicate the selection type of ship feature.

Enumerator
TypesStructureSystem 

The structure system type.

TypesFeature 

The feature type which is valid only in ship basic design application.

Member Function Documentation

double NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::AngularTolerance ( )

Returns the angular tolerance used for geometry comparison and defined in the customer defaults.


Created in NX10.0.0.

License requirements : None

NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::AppTypes NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::ApplicationType ( )

Returns the application type, which is ship basic design or ship detail design.


Created in NX11.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::LinearToleranceFactor ( )

Returns the linear tolerance factor used for the geometry comparison and defined in the customer default.


Created in NX10.0.0.

License requirements : None

NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorApproach NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorApproachOption ( )

Returns an option to determines the approach to copy and mirror ship standard parts.


Created in NX11.0.2.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorPlane ( )

Returns the mirror plane.


Created in NX10.0.0.

License requirements : None

NXOpen::Features::SelectFeatureList* NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::OriginalFeatures ( )

Returns the list of features to Mirror Copy.


Created in NX11.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::OriginalParts ( )

Returns the list of parts (or components) to Mirror Copy.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::ReportMirrorResultXML ( )

Returns an XML report with mirror process information will be shown if set to true.


Created in NX10.0.0.

License requirements : None

NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::Types NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SelectionType ( )

Returns the selection type, which is structure system or feature.


Created in NX11.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetAngularTolerance ( double  angularTolerance)

Sets the angular tolerance used for geometry comparison and defined in the customer defaults.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
angularToleranceangulartolerance
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetApplicationType ( NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::AppTypes  type)

Sets the application type, which is ship basic design or ship detail design.


Created in NX11.0.0.

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

Parameters
typetype
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetLinearToleranceFactor ( double  linearToleranceFactor)

Sets the linear tolerance factor used for the geometry comparison and defined in the customer default.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
linearToleranceFactorlineartolerancefactor
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetMirrorApproachOption ( NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::MirrorApproach  mirrorApproachOption)

Sets an option to determines the approach to copy and mirror ship standard parts.


Created in NX11.0.2.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
mirrorApproachOptionmirrorapproachoption
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetMirrorPlane ( NXOpen::Plane mirrorPlane)

Sets the mirror plane.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
mirrorPlanemirrorplane
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetReportMirrorResultXML ( bool  reportMirrorResultXML)

Sets an XML report with mirror process information will be shown if set to true.


Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
reportMirrorResultXMLreportmirrorresultxml
void NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SetSelectionType ( NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::Types  type)

Sets the selection type, which is structure system or feature.


Created in NX11.0.0.

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

Parameters
typetype
int NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::SortComponentByInterPartDependency ( std::vector< NXString > &  nonBreakableCircles,
std::vector< NXString > &  brokenCircles 
)

Sort components by inter-part dependency and return dependency circles.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
nonBreakableCirclesnonbreakablecircles
brokenCirclesbrokencircles
NXOpen::Assemblies::SelectComponentList* NXOpen::Features::ShipDesign::MirrorShipStructureBuilder::TargetPart ( )

Returns the target parts or components where the selected features will be mirror copied into.


Created in NX11.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.