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

Represents a NXOpen::Features::ShipDesign::CopyPasteNewBuilder It is used in Ship Building Application. More...

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

Public Types

enum  CopyApproach { CopyApproachTransferringLinkedBody, CopyApproachCopySourceFeaturesAndReparent }
 Represents the approach of copying ship standard parts. More...
 
enum  VersionID { VersionIDNx11, VersionIDNx12 }
 add version identifiers for the different revisions of the copy paste new feature. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::CopyPasteNewBuilder::VersionID AlgorithmVersion ()
 Returns the value of algorithm version is used to define the version information. More...
 
double AngularTolerance ()
 Returns the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal. More...
 
virtual NXOpen::ErrorListAutoAssignAttributes (const std::vector< NXOpen::NXObject * > &objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::ErrorListAutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
NXOpen::SelectNXObjectListComponentsToCopy ()
 Returns the components to copy
Created in NX8.0.0. More...
 
NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopyApproach CopyApproachOption ()
 Returns an option to determine the approach to copy the ship standard parts between planes. More...
 
bool CopySection ()
 Returns the flag is used to define if linear tolerance on UI would be used when matching geometry. More...
 
virtual NXOpen::NXObjectCreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern. More...
 
void CreateLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Creates the pre-creation logical objects
Created in NX8.5.0. More...
 
NXOpen::ErrorListGetOperationFailures ()
 Gets the operation failure error list object. More...
 
double LinearTolerance ()
 Returns the value of linear tolerance is used to define the tolerance between candidate object and transformed source object. More...
 
NXOpen::SelectNXObjectSelectionFrom ()
 Returns the From geometry
Created in NX8.0.0. More...
 
NXOpen::SelectNXObjectListSelectionTo ()
 Returns the To geometry
Created in NX8.0.0. More...
 
void SetAlgorithmVersion (NXOpen::Features::ShipDesign::CopyPasteNewBuilder::VersionID algorithmVersion)
 Sets the value of algorithm version is used to define the version information. More...
 
void SetAngularTolerance (double tolerance)
 Sets the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal. More...
 
void SetCopyApproachOption (NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopyApproach copyApproachOption)
 Sets an option to determine the approach to copy the ship standard parts between planes. More...
 
void SetCopySection (bool copySection)
 Sets the flag is used to define if linear tolerance on UI would be used when matching geometry. More...
 
void SetLinearTolerance (double tolerance)
 Sets the value of linear tolerance is used to define the tolerance between candidate object and transformed source object. More...
 
void SetShowXmlReport (bool showXmlReport)
 Sets the flag to indicate whether or not to show the xml report on copy paste results
Created in NX11.0.0. More...
 
NXOpen::Features::ShipDesign::ShipNamesListBuilderShipNames ()
 Returns the Ship Names builder, used to assign names to the copied objects created. More...
 
bool ShowXmlReport ()
 Returns the flag to indicate whether or not to show the xml report on copy paste results
Created in NX11.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::CopyPasteNewBuilder It is used in Ship Building Application.

The operation copies one or more components and pastes them as new parts while re-parenting and maintaining WAVE links
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateCopyPasteNewBuilder
Default values.

Property Value

AngularTolerance

5

CopySection

false


Created in NX8.0.0.

Member Enumeration Documentation

Represents the approach of copying ship standard parts.

Enumerator
CopyApproachTransferringLinkedBody 

The approach by transferring linked body.

CopyApproachCopySourceFeaturesAndReparent 

The approach by copy source features and reparenting.

add version identifiers for the different revisions of the copy paste new feature.

Enumerator
VersionIDNx11 

nx11

VersionIDNx12 

nx12

Member Function Documentation

NXOpen::Features::ShipDesign::CopyPasteNewBuilder::VersionID NXOpen::Features::ShipDesign::CopyPasteNewBuilder::AlgorithmVersion ( )

Returns the value of algorithm version is used to define the version information.


Created in NX12.0.0.

License requirements : None

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

Returns the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal.


Created in NX11.0.0.

License requirements : None

virtual NXOpen::ErrorList* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::AutoAssignAttributes ( const std::vector< NXOpen::NXObject * > &  objects)
virtual

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
objectsobjects

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::ErrorList* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::AutoAssignAttributesWithNamingPattern ( const std::vector< NXOpen::NXObject * > &  objects,
const std::vector< NXOpen::NXObject * > &  properties 
)
virtual

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap

Returns

Created in NX12.0.0.

License requirements : None
Parameters
objectsobjects
propertiesproperties

Implements NXOpen::IAttributeSourceObjectBuilder.

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::ComponentsToCopy ( )

Returns the components to copy
Created in NX8.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopyApproach NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopyApproachOption ( )

Returns an option to determine the approach to copy the ship standard parts between planes.


Created in NX11.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopySection ( )

Returns the flag is used to define if linear tolerance on UI would be used when matching geometry.

If false, the linear tolerance will be set with max double value as default.
Created in NX11.0.0.

License requirements : None

virtual NXOpen::NXObject* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CreateAttributeTitleToNamingPatternMap ( std::vector< NXString > &  attributeTitles,
std::vector< NXString > &  titlePatterns 
)
virtual

Creates a map object of attribute titles to their corresponding naming pattern.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
attributeTitlesattributetitles
titlePatternstitlepatterns

Implements NXOpen::IAttributeSourceObjectBuilder.

void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CreateLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Creates the pre-creation logical objects
Created in NX8.5.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
logicalObjectslogicalobjects
NXOpen::ErrorList* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::GetOperationFailures ( )

Gets the operation failure error list object.

Returns
List of errors encountered during the copy parts
Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")
double NXOpen::Features::ShipDesign::CopyPasteNewBuilder::LinearTolerance ( )

Returns the value of linear tolerance is used to define the tolerance between candidate object and transformed source object.

For example, the distance from the qualified candidate curve to the transformed sample points of source curve shoud be within linear tolerance. And for body, it checks the distance from the qualified body's faces and the transformed sample points of source body's corresponding faces.
Created in NX11.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SelectionFrom ( )

Returns the From geometry
Created in NX8.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SelectionTo ( )

Returns the To geometry
Created in NX8.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetAlgorithmVersion ( NXOpen::Features::ShipDesign::CopyPasteNewBuilder::VersionID  algorithmVersion)

Sets the value of algorithm version is used to define the version information.


Created in NX12.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
algorithmVersionalgorithmversion
void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetAngularTolerance ( double  tolerance)

Sets the value of angular tolerance is used to define the angular difference from qualified candidate face / plane normal to source face / plane normal.


Created in NX11.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetCopyApproachOption ( NXOpen::Features::ShipDesign::CopyPasteNewBuilder::CopyApproach  copyApproachOption)

Sets an option to determine the approach to copy the ship standard parts between planes.


Created in NX11.0.2.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
copyApproachOptioncopyapproachoption
void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetCopySection ( bool  copySection)

Sets the flag is used to define if linear tolerance on UI would be used when matching geometry.

If false, the linear tolerance will be set with max double value as default.
Created in NX11.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
copySectioncopysection
void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetLinearTolerance ( double  tolerance)

Sets the value of linear tolerance is used to define the tolerance between candidate object and transformed source object.

For example, the distance from the qualified candidate curve to the transformed sample points of source curve shoud be within linear tolerance. And for body, it checks the distance from the qualified body's faces and the transformed sample points of source body's corresponding faces.
Created in NX11.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::CopyPasteNewBuilder::SetShowXmlReport ( bool  showXmlReport)

Sets the flag to indicate whether or not to show the xml report on copy paste results
Created in NX11.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
showXmlReportshowxmlreport
NXOpen::Features::ShipDesign::ShipNamesListBuilder* NXOpen::Features::ShipDesign::CopyPasteNewBuilder::ShipNames ( )

Returns the Ship Names builder, used to assign names to the copied objects created.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::CopyPasteNewBuilder::ShowXmlReport ( )

Returns the flag to indicate whether or not to show the xml report on copy paste results
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.