NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Features::ShipDesign::DrawingAnnotationBuilder Class Reference

This builder allows you to define the drawing annotation information. More...

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

Public Types

enum  Annotation { AnnotationPreserve, AnnotationDelete }
 Settings that indicate how to handle the exsiting annotation in the drawing. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::Annotation ExistingAutomaticAnnotation ()
 Returns the option specify how to handle existing annotation
Created in NX10.0.0. More...
 
bool IsCreateContinuitySymbolOnSectionStiffener ()
 Returns the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects
Created in NX10.0.0. More...
 
bool IsCreateFireAndSafetyPlan ()
 Returns the setting that indicates whether the fire and safety plan symbol will be created for the ship objects or not. More...
 
bool IsCreateOpeningFillLines ()
 Returns the setting that indicates whether opening fill lines will be created for ship objects
Created in NX10.0.0. More...
 
bool IsCreateScantling ()
 Returns the setting that indicates whether scantling will be created for the ship objects
Created in NX10.0.0. More...
 
bool IsCreateScantlingTable ()
 Returns the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view. More...
 
bool IsCreateStiffenerSectionSymbol ()
 Returns the setting that indicates whether the section symbol will be created for stiffeners
Created in NX10.0.0. More...
 
bool IsCreateStructureID ()
 Returns the setting that indicates whether structure id will be created for ship objects
Created in NX10.0.0. More...
 
void SetCreateContinuitySymbolOnSectionStiffener (bool isCreateContinuitySymbolOnSectionStiffener)
 Sets the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects
Created in NX10.0.0. More...
 
void SetCreateFireAndSafetyPlan (bool isCreateFireAndSafetyPlan)
 Sets the setting that indicates whether the fire and safety plan symbol will be created for the ship objects or not. More...
 
void SetCreateOpeningFillLines (bool isCreateOpeningFillLines)
 Sets the setting that indicates whether opening fill lines will be created for ship objects
Created in NX10.0.0. More...
 
void SetCreateScantling (bool isCreateScantling)
 Sets the setting that indicates whether scantling will be created for the ship objects
Created in NX10.0.0. More...
 
void SetCreateScantlingTable (bool isCreateScantlingTable)
 Sets the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view. More...
 
void SetCreateStiffenerSectionSymbol (bool isCreateStiffenerSectionSymbol)
 Sets the setting that indicates whether the section symbol will be created for stiffeners
Created in NX10.0.0. More...
 
void SetCreateStructureID (bool isCreateStructureID)
 Sets the setting that indicates whether structure id will be created for ship objects
Created in NX10.0.0. More...
 
void SetExistingAutomaticAnnotation (NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::Annotation existingAutomaticAnnotation)
 Sets the option specify how to handle existing annotation
Created in NX10.0.0. More...
 
NXOpen::Drawings::SelectDraftingViewListViewList ()
 Returns the drafting views to be annotated
Created in NX10.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

This builder allows you to define the drawing annotation information.

It represents NXOpen::Features::ShipDesign::DrawingAnnotationBuilder
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateDrawingAnnotationBuilder
Default values.

Property Value

ExistingAutomaticAnnotation

Preserve

IsCreateOpeningFillLines

1

IsCreateScantling

1

IsCreateScantlingTable

1

IsCreateStructureID

0


Created in NX10.0.0.

Member Enumeration Documentation

Settings that indicate how to handle the exsiting annotation in the drawing.

Enumerator
AnnotationPreserve 

preserve

AnnotationDelete 

delete

Member Function Documentation

NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::Annotation NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::ExistingAutomaticAnnotation ( )

Returns the option specify how to handle existing annotation
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateContinuitySymbolOnSectionStiffener ( )

Returns the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateFireAndSafetyPlan ( )

Returns the setting that indicates whether the fire and safety plan symbol will be created for the ship objects or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateOpeningFillLines ( )

Returns the setting that indicates whether opening fill lines will be created for ship objects
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateScantling ( )

Returns the setting that indicates whether scantling will be created for the ship objects
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateScantlingTable ( )

Returns the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view.

If yes, the stiffener and plate scantlings, other than the most common one, will not be created.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateStiffenerSectionSymbol ( )

Returns the setting that indicates whether the section symbol will be created for stiffeners
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::IsCreateStructureID ( )

Returns the setting that indicates whether structure id will be created for ship objects
Created in NX10.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateContinuitySymbolOnSectionStiffener ( bool  isCreateContinuitySymbolOnSectionStiffener)

Sets the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateContinuitySymbolOnSectionStiffeneriscreatecontinuitysymbolonsectionstiffener
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateFireAndSafetyPlan ( bool  isCreateFireAndSafetyPlan)

Sets the setting that indicates whether the fire and safety plan symbol will be created for the ship objects or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateFireAndSafetyPlaniscreatefireandsafetyplan
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateOpeningFillLines ( bool  isCreateOpeningFillLines)

Sets the setting that indicates whether opening fill lines will be created for ship objects
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateOpeningFillLinesiscreateopeningfilllines
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateScantling ( bool  isCreateScantling)

Sets the setting that indicates whether scantling will be created for the ship objects
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateScantlingiscreatescantling
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateScantlingTable ( bool  isCreateScantlingTable)

Sets the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view.

If yes, the stiffener and plate scantlings, other than the most common one, will not be created.


Created in NX10.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateScantlingTableiscreatescantlingtable
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateStiffenerSectionSymbol ( bool  isCreateStiffenerSectionSymbol)

Sets the setting that indicates whether the section symbol will be created for stiffeners
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateStiffenerSectionSymboliscreatestiffenersectionsymbol
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetCreateStructureID ( bool  isCreateStructureID)

Sets the setting that indicates whether structure id will be created for ship objects
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
isCreateStructureIDiscreatestructureid
void NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::SetExistingAutomaticAnnotation ( NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::Annotation  existingAutomaticAnnotation)

Sets the option specify how to handle existing annotation
Created in NX10.0.0.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_mfg_prep ("Ship Manufacturing")

Parameters
existingAutomaticAnnotationexistingautomaticannotation
NXOpen::Drawings::SelectDraftingViewList* NXOpen::Features::ShipDesign::DrawingAnnotationBuilder::ViewList ( )

Returns the drafting views to be annotated
Created in NX10.0.0.



License requirements : None


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