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

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

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

Public Types

enum  Type { TypePart, TypeFeature }
 Type of Source Objects. More...
 
enum  VersionID { VersionIDNx11, VersionIDNx12 }
 add version identifiers for the different revisions of the copy objects builder. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::CopyObjectsBuilder::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 the qualified candidate face / plane normal to source face / plane normal. More...
 
NXOpen::SelectNXObjectCopyFrom ()
 Returns the plane where the source objects to be copied from. More...
 
bool CopySection ()
 Returns the flag is used to define if linear tolerance on UI would be used when matching geometry. More...
 
NXOpen::SelectNXObjectListCopyTo ()
 Returns the target objects where the source objects to be copied to. More...
 
NXOpen::SelectNXObjectListInputObjects ()
 Returns the source input objects to copy. More...
 
double LinearTolerance ()
 Returns the value of linear tolerance is used to define the tolerance between candidate object and transformed source object. More...
 
NXOpen::Features::ShipDesign::CopyObjectsBuilder::Type ObjectType ()
 Returns the type of objects to copy. More...
 
void SetAlgorithmVersion (NXOpen::Features::ShipDesign::CopyObjectsBuilder::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 the qualified candidate face / plane normal to source face / plane normal. 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 SetObjectType (NXOpen::Features::ShipDesign::CopyObjectsBuilder::Type objectType)
 Sets the type of objects to copy. More...
 
void SetShowXmlReport (bool showXmlReport)
 Sets the flag to indicate whether or not to show the xml report on copy basic design part 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 basic design part results
Created in NX11.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::CopyObjectsBuilder It is used in Ship Building Application.

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

Property Value

AngularTolerance

5

CopySection

false

ObjectType

Part


Created in NX10.0.0.

Member Enumeration Documentation

Type of Source Objects.

Enumerator
TypePart 

part

TypeFeature 

feature

add version identifiers for the different revisions of the copy objects builder.

Enumerator
VersionIDNx11 

nx11

VersionIDNx12 

nx12

Member Function Documentation

NXOpen::Features::ShipDesign::CopyObjectsBuilder::VersionID NXOpen::Features::ShipDesign::CopyObjectsBuilder::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::CopyObjectsBuilder::AngularTolerance ( )

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


Created in NX11.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::CopyObjectsBuilder::CopyFrom ( )

Returns the plane where the source objects to be copied from.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::CopyObjectsBuilder::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

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::CopyObjectsBuilder::CopyTo ( )

Returns the target objects where the source objects to be copied to.


Created in NX10.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::CopyObjectsBuilder::InputObjects ( )

Returns the source input objects to copy.


Created in NX10.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::CopyObjectsBuilder::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::Features::ShipDesign::CopyObjectsBuilder::Type NXOpen::Features::ShipDesign::CopyObjectsBuilder::ObjectType ( )

Returns the type of objects to copy.


Created in NX10.0.0.

License requirements : None

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

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


Created in NX12.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

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

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


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::CopyObjectsBuilder::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_basic ("Ship Basic Design")

Parameters
copySectioncopysection
void NXOpen::Features::ShipDesign::CopyObjectsBuilder::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_basic ("Ship Basic Design")

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::CopyObjectsBuilder::SetObjectType ( NXOpen::Features::ShipDesign::CopyObjectsBuilder::Type  objectType)

Sets the type of objects to copy.


Created in NX10.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
objectTypeobjecttype
void NXOpen::Features::ShipDesign::CopyObjectsBuilder::SetShowXmlReport ( bool  showXmlReport)

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



License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
showXmlReportshowxmlreport
NXOpen::Features::ShipDesign::ShipNamesListBuilder* NXOpen::Features::ShipDesign::CopyObjectsBuilder::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::CopyObjectsBuilder::ShowXmlReport ( )

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