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

Used to interrogate and change the processing within the NXOpen::Features::ShipDesign::ShipPreparationBuilder . More...

Inheritance diagram for NXOpen::Features::ShipDesign::ShipPreparationInfo:
NXOpen::TransientObject

Public Types

enum  Types {
  TypesUnknown, TypesLinkedBody, TypesLinkedBodyBracket, TypesLinkedEdges,
  TypesLinkedCurves, TypesLinkedFaces, TypesPlateDivide, TypesStiffenerDivide,
  TypesStiffenerBySupportDivide, TypesEdgeReinforcementDivide, TypesEdgeReinforcementEdges, TypesStandardPartBracketDivide,
  TypesPillar, TypesBracketDivide, TypesUserDefined
}
 Used to specify the type of object represented in the data. More...
 

Public Member Functions

NXOpen::Features::FeatureBasicDesignFeature ()
 Returns the basic design feature related to this information. More...
 
double BlendRadius ()
 Returns the blend radius. More...
 
bool ExtendImprints ()
 Returns the option to extend the imprints. More...
 
NXOpen::Features::FeatureFeature ()
 Returns the feature generating this information. More...
 
void GetImprintData (std::vector< NXOpen::NXObject * > &imprintData)
 Gets the data to be imprinted onto the target plate system. More...
 
void GetLinkedData (std::vector< NXOpen::NXObject * > &linkedData)
 Gets the linked data of the object. More...
 
void GetSourceData (std::vector< NXOpen::NXObject * > &sourceData)
 Gets the source data of the object. More...
 
double HoleDiameter ()
 Returns the hole diameter. More...
 
double MaximumExtensionDistance ()
 Returns the maximum distance edges will be extended to completion. More...
 
NXOpen::Features::ShipDesign::ShipPreparationInfoParent ()
 Returns the parent of the Ship Preparation feature. More...
 
bool RemoveBlends ()
 Returns the option to remove blends. More...
 
bool RemoveOpenings ()
 Returns the option to remove openings. More...
 
void SetBasicDesignFeature (NXOpen::Features::Feature *feature)
 Sets the basic design feature related to this information. More...
 
void SetBlendRadius (double blendRadius)
 Sets the blend radius. More...
 
void SetExtendImprints (bool extendImprints)
 Sets the option to extend the imprints. More...
 
void SetFeature (NXOpen::Features::Feature *feature)
 Sets the feature generating this information. More...
 
void SetHoleDiameter (double holeDiameter)
 Sets the hole diameter. More...
 
void SetImprintData (const std::vector< NXOpen::NXObject * > &imprintData)
 Sets the data to be imprinted onto the target plate system. More...
 
void SetMaximumExtensionDistance (double maximumExtensionDistance)
 Sets the maximum distance edges will be extended to completion. More...
 
void SetParent (NXOpen::Features::ShipDesign::ShipPreparationInfo *parent)
 Sets the parent of the Ship Preparation feature. More...
 
void SetRemoveBlends (bool removeBlends)
 Sets the option to remove blends. More...
 
void SetRemoveOpenings (bool removeOpenings)
 Sets the option to remove openings. More...
 
void SetSourceData (const std::vector< NXOpen::NXObject * > &sourceData)
 Sets the source data of the object. More...
 
void SetTarget (NXOpen::Features::ShipDesign::ShipPreparationInfo *target)
 Sets the target FeatureInfo for the divide operation. More...
 
void SetTargetBody (NXOpen::Body *targetBody)
 Sets the target body for the divide operation. More...
 
void SetToBeDeleted (bool toBeDeleted)
 Sets the indication if this preparation data should be deleted or not. More...
 
void SetType (NXOpen::Features::ShipDesign::ShipPreparationInfo::Types type)
 Sets the type of Ship Preparation feature. More...
 
NXOpen::Assemblies::ComponentSourcePart ()
 Returns the source part file of the linked data. More...
 
NXOpen::Features::ShipDesign::ShipPreparationInfoTarget ()
 Returns the target FeatureInfo for the divide operation. More...
 
NXOpen::BodyTargetBody ()
 Returns the target body for the divide operation. More...
 
bool ToBeDeleted ()
 Returns the indication if this preparation data should be deleted or not. More...
 
NXOpen::Features::ShipDesign::ShipPreparationInfo::Types Type ()
 Returns the type of Ship Preparation feature. More...
 
virtual ~ShipPreparationInfo ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Used to interrogate and change the processing within the NXOpen::Features::ShipDesign::ShipPreparationBuilder .

The following is a description of the class for each NXOpen::Features::ShipDesign::ShipPreparationInfo::Types setting. If a description is not given for a class property or method, then that property or method is not applicable, except for NXOpen::Features::ShipDesign::ShipPreparationInfo::ToBeDeleted is always applicable. This is the way the data is set up after calling NXOpen::Features::ShipDesign::ShipPreparationBuilder::FindBasicDesignData .


Used to create the linked body feature for plate systems. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody .



Used to create the linked body features for Brackets.



Used to create composite curve features for edges of intersection seams. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedEdges .



Used to create linked composite curve features for intersection seams, curves of standard part brackets, and pillar curves. When the linked target body is created for intersection seams, the edges on this linked body for the intersection seam curves will be found. If they are found the edges will be transferred to the NXOpen::Features::ShipDesign::ShipPreparationInfo that contains the edges that are part of a composite curve feature. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedCurves .



Used to create linked face features for stiffener and edge reinforcement base faces. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedFaces .



Used to create plate divide features for imprinting the bounded sheets and intersection seams onto a plate system linked body. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .



Used to create divide features for imprinting the stiffener systems, and on face edge reinforcements onto a plate system linked body. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesStiffenerDivide , or NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesStiffenerBySupportDivide .



Used to create edge reinforcement marking features for splitting the edges on a linked plate system body when needed. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesEdgeReinforcementDivide .



Used to create edge reinforcement marking features for labelling the edges of the plate system linked body where edge reinforcements exist. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesEdgeReinforcementEdges .



Used to create divide features for imprinting the curves of a standard part bracket. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesStandardPartBracketDivide .



Used to create divide features for imprinting the body of a new bracket. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesBracketDivide .



Used to create pillar points features which outputs the end points for beam creation. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPillar .



Used to create plate divide features for user supplied bodies and curves onto a plate system linked body. When NXOpen::Features::ShipDesign::ShipPreparationInfo::Types returns NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesUserDefined .



Created in NX11.0.0.

Member Enumeration Documentation

Used to specify the type of object represented in the data.

Enumerator
TypesUnknown 

Type of data not known yet.

TypesLinkedBody 

The data represents a linked body feature.

TypesLinkedBodyBracket 

The data represents a linked body feature for the new Bracket body.

TypesLinkedEdges 

The data represents a composite curve feature extracting edges.

TypesLinkedCurves 

The data represents a linked composite curve feature.

TypesLinkedFaces 

The data represents a linked face feature.

TypesPlateDivide 

The data represents a plate divide feature.

TypesStiffenerDivide 

The data represents a stiffener divide feature.

TypesStiffenerBySupportDivide 

The data represents a stiffener divide feature, for a stiffener by support.

TypesEdgeReinforcementDivide 

The data represents a edge reinforcement divide feature.

This feature handles splitting edges when needed.

TypesEdgeReinforcementEdges 

The data represents a edge reinforcement divide feature.

This feature handles labelling the edges of the linked body.

TypesStandardPartBracketDivide 

The data represents a standard part bracket divide feature.

TypesPillar 

The data represents a pillar feature.

TypesBracketDivide 

The data represents a bracket divide feature.

TypesUserDefined 

The data represents a user defined divide feature.

Constructor & Destructor Documentation

virtual NXOpen::Features::ShipDesign::ShipPreparationInfo::~ShipPreparationInfo ( )
virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX11.0.0.

License requirements : None

Member Function Documentation

NXOpen::Features::Feature* NXOpen::Features::ShipDesign::ShipPreparationInfo::BasicDesignFeature ( )

Returns the basic design feature related to this information.


Created in NX11.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::ShipPreparationInfo::BlendRadius ( )

Returns the blend radius.

If Features::ShipDesign::ShipPreparationInfo::RemoveBlends and Features::ShipDesign::ShipPreparationInfo::SetRemoveBlends is true then blends that that are less than or equal to this radius will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipPreparationInfo::ExtendImprints ( )
NXOpen::Features::Feature* NXOpen::Features::ShipDesign::ShipPreparationInfo::Feature ( )

Returns the feature generating this information.

Will be NULL before the feature is actually created.
Created in NX11.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationInfo::GetImprintData ( std::vector< NXOpen::NXObject * > &  imprintData)
void NXOpen::Features::ShipDesign::ShipPreparationInfo::GetLinkedData ( std::vector< NXOpen::NXObject * > &  linkedData)

Gets the linked data of the object.

Only valid when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBodyBracket , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedEdges , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedCurves , or NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedFaces . This will only be set after the basic design data has been linked.
Created in NX11.0.0.

License requirements : None

Parameters
linkedDataThe objects linked into the preparation part.
void NXOpen::Features::ShipDesign::ShipPreparationInfo::GetSourceData ( std::vector< NXOpen::NXObject * > &  sourceData)
double NXOpen::Features::ShipDesign::ShipPreparationInfo::HoleDiameter ( )

Returns the hole diameter.

If Features::ShipDesign::ShipPreparationInfo::RemoveOpenings and Features::ShipDesign::ShipPreparationInfo::SetRemoveOpenings is true then openings that fit inside a circle with this diameter will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::ShipPreparationInfo::MaximumExtensionDistance ( )
NXOpen::Features::ShipDesign::ShipPreparationInfo* NXOpen::Features::ShipDesign::ShipPreparationInfo::Parent ( )
bool NXOpen::Features::ShipDesign::ShipPreparationInfo::RemoveBlends ( )

Returns the option to remove blends.

If true, blends with a radius less than or equal to Features::ShipDesign::ShipPreparationInfo::BlendRadius and Features::ShipDesign::ShipPreparationInfo::SetBlendRadius will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipPreparationInfo::RemoveOpenings ( )

Returns the option to remove openings.

If true, openings that fit inside a circle with diameter Features::ShipDesign::ShipPreparationInfo::HoleDiameter and Features::ShipDesign::ShipPreparationInfo::SetHoleDiameter will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetBasicDesignFeature ( NXOpen::Features::Feature feature)

Sets the basic design feature related to this information.


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
featurefeature
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetBlendRadius ( double  blendRadius)

Sets the blend radius.

If Features::ShipDesign::ShipPreparationInfo::RemoveBlends and Features::ShipDesign::ShipPreparationInfo::SetRemoveBlends is true then blends that that are less than or equal to this radius will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
blendRadiusblendradius
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetExtendImprints ( bool  extendImprints)
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetFeature ( NXOpen::Features::Feature feature)

Sets the feature generating this information.

Will be NULL before the feature is actually created.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
featurefeature
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetHoleDiameter ( double  holeDiameter)

Sets the hole diameter.

If Features::ShipDesign::ShipPreparationInfo::RemoveOpenings and Features::ShipDesign::ShipPreparationInfo::SetRemoveOpenings is true then openings that fit inside a circle with this diameter will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
holeDiameterholediameter
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetImprintData ( const std::vector< NXOpen::NXObject * > &  imprintData)
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetMaximumExtensionDistance ( double  maximumExtensionDistance)
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetParent ( NXOpen::Features::ShipDesign::ShipPreparationInfo parent)

Sets the parent of the Ship Preparation feature.

The Ship Preparation feature will be made a slave of this feature. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBodyBracket , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedEdges , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedCurves , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedFaces , or NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesEdgeReinforcementEdges .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
parentparent
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetRemoveBlends ( bool  removeBlends)

Sets the option to remove blends.

If true, blends with a radius less than or equal to Features::ShipDesign::ShipPreparationInfo::BlendRadius and Features::ShipDesign::ShipPreparationInfo::SetBlendRadius will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
removeBlendsremoveblends
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetRemoveOpenings ( bool  removeOpenings)

Sets the option to remove openings.

If true, openings that fit inside a circle with diameter Features::ShipDesign::ShipPreparationInfo::HoleDiameter and Features::ShipDesign::ShipPreparationInfo::SetHoleDiameter will be removed from plate systems. Only used when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesPlateDivide .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
removeOpeningsremoveopenings
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetSourceData ( const std::vector< NXOpen::NXObject * > &  sourceData)

Sets the source data of the object.

Only valid when Type is NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBodyBracket , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedEdges , NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedCurves , or NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedFaces .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
sourceDataThe objects to be linked into the preparation part.
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetTarget ( NXOpen::Features::ShipDesign::ShipPreparationInfo target)

Sets the target FeatureInfo for the divide operation.

Valid for all Types except NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody .
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
targettarget
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetTargetBody ( NXOpen::Body targetBody)

Sets the target body for the divide operation.

Can be NULL. Valid for all Types except NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody . This will typically only be set after the basic design data has been linked.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
targetBodytargetbody
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetToBeDeleted ( bool  toBeDeleted)

Sets the indication if this preparation data should be deleted or not.

If you want to remove this data from ship preparation consideration, set this option to true. Do not remove the data from processing since clean up of unwanted data will not occur.
Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
toBeDeletedtobedeleted
void NXOpen::Features::ShipDesign::ShipPreparationInfo::SetType ( NXOpen::Features::ShipDesign::ShipPreparationInfo::Types  type)

Sets the type of Ship Preparation feature.


Created in NX11.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters
typetype
NXOpen::Assemblies::Component* NXOpen::Features::ShipDesign::ShipPreparationInfo::SourcePart ( )
NXOpen::Features::ShipDesign::ShipPreparationInfo* NXOpen::Features::ShipDesign::ShipPreparationInfo::Target ( )

Returns the target FeatureInfo for the divide operation.

Valid for all Types except NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody .
Created in NX11.0.0.

License requirements : None

NXOpen::Body* NXOpen::Features::ShipDesign::ShipPreparationInfo::TargetBody ( )

Returns the target body for the divide operation.

Can be NULL. Valid for all Types except NXOpen::Features::ShipDesign::ShipPreparationInfo::TypesLinkedBody . This will typically only be set after the basic design data has been linked.
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::ShipPreparationInfo::ToBeDeleted ( )

Returns the indication if this preparation data should be deleted or not.

If you want to remove this data from ship preparation consideration, set this option to true. Do not remove the data from processing since clean up of unwanted data will not occur.
Created in NX11.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ShipPreparationInfo::Types NXOpen::Features::ShipDesign::ShipPreparationInfo::Type ( )

Returns the type of Ship Preparation feature.


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.