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

Represents a NXOpen::Features::ShipDesign::SplitProfilePlateBuilder .This class is for splitting ship profile/plate solidbodies
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateSplitProfilePlateBuilder
Default values. More...

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

Public Types

enum  ProfileType { ProfileTypeProfileOrPlate, ProfileTypeBuiltUp }
 Represents the target body type. More...
 
enum  SplitDirectionOptionType { SplitDirectionOptionTypePerpendicularToMoldingFace, SplitDirectionOptionTypeAlongPlaneOrFace }
 Represents split direction to trim profile or plate solid body . More...
 
enum  ToolOptionType { ToolOptionTypePlane, ToolOptionTypeNewPlane, ToolOptionTypeExtrude, ToolOptionTypeBody }
 Represents trim tool type to trim profile or plate solid body. More...
 

Public Member Functions

bool ApplyEndCut ()
 Returns the option to indicate whether to apply the end cut to the profiles
Created in NX9.0.0. More...
 
NXOpen::Features::ShipDesign::BuiltUpOffsetBuilderBuiltUpOffset ()
 Returns the built-up offset data
Created in NX9.0.0. More...
 
double DistanceTolerance ()
 Returns the distance tolerance to determine if a profile is attached to a plate
Created in NX8.5.0. More...
 
bool DoTrimWithoutCopy ()
 Returns the option to determine if target bodies will be copied. More...
 
bool ReverseDirection ()
 Returns the reverse direction option of tool datum or face for split. More...
 
void SetApplyEndCut (bool applyEndCut)
 Sets the option to indicate whether to apply the end cut to the profiles
Created in NX9.0.0. More...
 
void SetDistanceTolerance (double dDistnaceTolerance)
 Sets the distance tolerance to determine if a profile is attached to a plate
Created in NX8.5.0. More...
 
void SetDoTrimWithoutCopy (bool doTrimWithoutCopy)
 Sets the option to determine if target bodies will be copied. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the reverse direction option of tool datum or face for split. More...
 
void SetSplitDirectionOption (NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SplitDirectionOptionType splitDirectionOption)
 Sets the option to split profile/plate along tool face or perpendicular to profile/plate molding face. More...
 
void SetTargetType (NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ProfileType profileType)
 Sets the profile type of split target. More...
 
void SetToolNewPlane (NXOpen::Plane *toolNewPlane)
 Sets the created new tool datum for split. More...
 
void SetToolOption (NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOptionType toolOption)
 Sets the tool type for split. More...
 
void SetToolVector (NXOpen::Direction *toolVector)
 Sets the tool vector to create extrude face for split. More...
 
void SetTrimDirection (const NXOpen::Vector3d &trimDirection)
 Sets the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed. More...
 
NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SplitDirectionOptionType SplitDirectionOption ()
 Returns the option to split profile/plate along tool face or perpendicular to profile/plate molding face. More...
 
NXOpen::SelectNXObjectListTargetBuiltUps ()
 Returns the target built-up solid bodies for split. More...
 
NXOpen::SelectNXObjectListTargetProfileOrPlates ()
 Returns the target profile or plate solid bodies for split. More...
 
NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ProfileType TargetType ()
 Returns the profile type of split target. More...
 
NXOpen::SelectBodyListToolBodies ()
 Returns the selected tool body for split. More...
 
NXOpen::SelectNXObjectListToolCurves ()
 Returns the tool curve(s) to create extrude face for split. More...
 
NXOpen::SectionToolCurvesSection ()
 Returns the tool curve(s) to create extrude face for split. More...
 
NXOpen::SelectNXObjectListToolFaces ()
 Returns the selected tool datum or face(s) for split. More...
 
NXOpen::PlaneToolNewPlane ()
 Returns the created new tool datum for split. More...
 
NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOptionType ToolOption ()
 Returns the tool type for split. More...
 
NXOpen::DirectionToolVector ()
 Returns the tool vector to create extrude face for split. More...
 
NXOpen::Vector3d TrimDirection ()
 Returns the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed. 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::SplitProfilePlateBuilder .This class is for splitting ship profile/plate solidbodies
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateSplitProfilePlateBuilder
Default values.

Property Value

BuiltUpOffset.FlangeAngle.Value

0

BuiltUpOffset.FlangeOffset.Value

0 (millimeters part), 0 (inches part)

BuiltUpOffset.WebAngle.Value

0

BuiltUpOffset.WebOffset.Value

0 (millimeters part), 0 (inches part)

ToolOption

Plane


Created in NX8.0.0.

Member Enumeration Documentation

Represents the target body type.

Enumerator
ProfileTypeProfileOrPlate 

Select profile or plate as target for split.

ProfileTypeBuiltUp 

Select built-up as target for split.

Represents split direction to trim profile or plate solid body .

Enumerator
SplitDirectionOptionTypePerpendicularToMoldingFace 

create plane/face perpendicular to molding face as the split tool

SplitDirectionOptionTypeAlongPlaneOrFace 

Split profile/plate along selected plane or face.

Represents trim tool type to trim profile or plate solid body.

Enumerator
ToolOptionTypePlane 

Select existing datum or face.

ToolOptionTypeNewPlane 

Create a new datum.

ToolOptionTypeExtrude 

Select curve and direction as extrude.

ToolOptionTypeBody 

Select plate or profile body.

Member Function Documentation

bool NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ApplyEndCut ( )

Returns the option to indicate whether to apply the end cut to the profiles
Created in NX9.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Features::ShipDesign::BuiltUpOffsetBuilder* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::BuiltUpOffset ( )

Returns the built-up offset data
Created in NX9.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

double NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::DistanceTolerance ( )

Returns the distance tolerance to determine if a profile is attached to a plate
Created in NX8.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::DoTrimWithoutCopy ( )

Returns the option to determine if target bodies will be copied.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

bool NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ReverseDirection ( )

Returns the reverse direction option of tool datum or face for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetApplyEndCut ( bool  applyEndCut)

Sets the option to indicate whether to apply the end cut to the profiles
Created in NX9.0.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
applyEndCutapplyendcut
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetDistanceTolerance ( double  dDistnaceTolerance)

Sets the distance tolerance to determine if a profile is attached to a plate
Created in NX8.5.0.



License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
dDistnaceToleranceddistnacetolerance
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetDoTrimWithoutCopy ( bool  doTrimWithoutCopy)

Sets the option to determine if target bodies will be copied.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
doTrimWithoutCopydotrimwithoutcopy
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the reverse direction option of tool datum or face for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
reverseDirectionreversedirection
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetSplitDirectionOption ( NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SplitDirectionOptionType  splitDirectionOption)

Sets the option to split profile/plate along tool face or perpendicular to profile/plate molding face.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
splitDirectionOptionsplitdirectionoption
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetTargetType ( NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ProfileType  profileType)

Sets the profile type of split target.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
profileTypeprofiletype
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetToolNewPlane ( NXOpen::Plane toolNewPlane)

Sets the created new tool datum for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
toolNewPlanetoolnewplane
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetToolOption ( NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOptionType  toolOption)

Sets the tool type for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
toolOptiontooloption
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetToolVector ( NXOpen::Direction toolVector)

Sets the tool vector to create extrude face for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
toolVectortoolvector
void NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SetTrimDirection ( const NXOpen::Vector3d trimDirection)

Sets the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

Parameters
trimDirectiontrimdirection
NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SplitDirectionOptionType NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::SplitDirectionOption ( )

Returns the option to split profile/plate along tool face or perpendicular to profile/plate molding face.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::TargetBuiltUps ( )

Returns the target built-up solid bodies for split.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::TargetProfileOrPlates ( )

Returns the target profile or plate solid bodies for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ProfileType NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::TargetType ( )

Returns the profile type of split target.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolBodies ( )

Returns the selected tool body for split.


Created in NX12.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolCurves ( )

Returns the tool curve(s) to create extrude face for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Section* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolCurvesSection ( )

Returns the tool curve(s) to create extrude face for split.

Only used when Type is NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOptionTypeExtrude .
Created in NX12.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolFaces ( )

Returns the selected tool datum or face(s) for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Plane* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolNewPlane ( )

Returns the created new tool datum for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOptionType NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolOption ( )

Returns the tool type for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Direction* NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::ToolVector ( )

Returns the tool vector to create extrude face for split.


Created in NX8.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")

NXOpen::Vector3d NXOpen::Features::ShipDesign::SplitProfilePlateBuilder::TrimDirection ( )

Returns the trim direction, which works together with Reverse Direction option, to determine which part of target body will be trimmed.


Created in NX9.0.0.

License requirements : nx_ship_detail ("Ship Detail Design")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.