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::GeneralArrangement::DrawingViewItemBuilder Class Reference

This builder allows you to define the general arrangement drawing view item information. More...

Inheritance diagram for NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder:
NXOpen::Features::ShipDesign::GeneralArrangement::DrawingItemBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FrameBarPositionType {
  FrameBarPositionTypeViewTop, FrameBarPositionTypeViewCenterY, FrameBarPositionTypeViewBottom, FrameBarPositionTypeViewLeft,
  FrameBarPositionTypeViewCenterX, FrameBarPositionTypeViewRight
}
 Settings to indicate the position of Frame Bar in X direction. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType HorizontalFrameBarPosition ()
 Returns the horizontal frame bar position
Created in NX12.0.2. More...
 
void SetHorizontalFrameBarPosition (NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType horizontalFrameBarPosition)
 Sets the horizontal frame bar position
Created in NX12.0.2. More...
 
void SetShowFireAndSafetyPlanSymbol (bool showFireAndSafetyPlanSymbol)
 Sets the flag to indicate whether to show the fire and safety plan symbol or not. More...
 
void SetShowHorizontalFrameBar (bool showHorizontalFrameBar)
 Sets the flag to indicate whether to show horizontal frame bar or not. More...
 
void SetShowOpeningFillingLine (bool showOpeningFillingLine)
 Sets the flag to indicate whether to show the opening filling line or not. More...
 
void SetShowOverallDimension (bool showOverallDimension)
 Sets the flag to indicate whether to show the overall dimension or not. More...
 
void SetShowPMILabel (bool showPMILabel)
 Sets the flag to indicate whether to show the PMI labels or not. More...
 
void SetShowVerticalFrameBar (bool showVerticalFrameBar)
 Sets the flag to indicate whether to show vertical frame bar or not. More...
 
void SetVerticalFrameBarPosition (NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType verticalFrameBarPosition)
 Sets the vertical frame bar position
Created in NX12.0.2. More...
 
bool ShowFireAndSafetyPlanSymbol ()
 Returns the flag to indicate whether to show the fire and safety plan symbol or not. More...
 
bool ShowHorizontalFrameBar ()
 Returns the flag to indicate whether to show horizontal frame bar or not. More...
 
bool ShowOpeningFillingLine ()
 Returns the flag to indicate whether to show the opening filling line or not. More...
 
bool ShowOverallDimension ()
 Returns the flag to indicate whether to show the overall dimension or not. More...
 
bool ShowPMILabel ()
 Returns the flag to indicate whether to show the PMI labels or not. More...
 
bool ShowVerticalFrameBar ()
 Returns the flag to indicate whether to show vertical frame bar or not. More...
 
NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType VerticalFrameBarPosition ()
 Returns the vertical frame bar position
Created in NX12.0.2. More...
 
- Public Member Functions inherited from NXOpen::Features::ShipDesign::GeneralArrangement::DrawingItemBuilder
bool CreateItem ()
 Returns the create item
Created in NX12.0.2. More...
 
void SetCreateItem (bool createItem)
 Sets the create item
Created in NX12.0.2. 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 general arrangement drawing view item information.

It represents NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder . This builder won't create General Arrangement View and just returns NULL.
To create a new instance of this class, use NXOpen::Features::ShipDesign::GeneralArrangement::DrawingAutomationBuilder::CreateDrawingViewItemBuilder
Default values.

Property Value

HorizontalFrameBarPosition

ViewTop

ShowFireAndSafetyPlanSymbol

0

ShowHorizontalFrameBar

0

ShowOpeningFillingLine

0

ShowOverallDimension

0

ShowPMILabel

0

ShowVerticalFrameBar

0

VerticalFrameBarPosition

ViewLeft


Created in NX12.0.2.

Member Enumeration Documentation

Settings to indicate the position of Frame Bar in X direction.

Enumerator
FrameBarPositionTypeViewTop 

view top

FrameBarPositionTypeViewCenterY 

view center y

FrameBarPositionTypeViewBottom 

view bottom

FrameBarPositionTypeViewLeft 

view left

FrameBarPositionTypeViewCenterX 

view center x

FrameBarPositionTypeViewRight 

view right

Member Function Documentation

NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::HorizontalFrameBarPosition ( )

Returns the horizontal frame bar position
Created in NX12.0.2.



License requirements : None

void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetHorizontalFrameBarPosition ( NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType  horizontalFrameBarPosition)

Sets the horizontal frame bar position
Created in NX12.0.2.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
horizontalFrameBarPositionhorizontalframebarposition
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowFireAndSafetyPlanSymbol ( bool  showFireAndSafetyPlanSymbol)

Sets the flag to indicate whether to show the fire and safety plan symbol or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showFireAndSafetyPlanSymbolshowfireandsafetyplansymbol
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowHorizontalFrameBar ( bool  showHorizontalFrameBar)

Sets the flag to indicate whether to show horizontal frame bar or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showHorizontalFrameBarshowhorizontalframebar
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowOpeningFillingLine ( bool  showOpeningFillingLine)

Sets the flag to indicate whether to show the opening filling line or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showOpeningFillingLineshowopeningfillingline
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowOverallDimension ( bool  showOverallDimension)

Sets the flag to indicate whether to show the overall dimension or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showOverallDimensionshowoveralldimension
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowPMILabel ( bool  showPMILabel)

Sets the flag to indicate whether to show the PMI labels or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showPMILabelshowpmilabel
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetShowVerticalFrameBar ( bool  showVerticalFrameBar)

Sets the flag to indicate whether to show vertical frame bar or not.


Created in NX12.0.2.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
showVerticalFrameBarshowverticalframebar
void NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::SetVerticalFrameBarPosition ( NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType  verticalFrameBarPosition)

Sets the vertical frame bar position
Created in NX12.0.2.



License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
verticalFrameBarPositionverticalframebarposition
bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowFireAndSafetyPlanSymbol ( )

Returns the flag to indicate whether to show the fire and safety plan symbol or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowHorizontalFrameBar ( )

Returns the flag to indicate whether to show horizontal frame bar or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowOpeningFillingLine ( )

Returns the flag to indicate whether to show the opening filling line or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowOverallDimension ( )

Returns the flag to indicate whether to show the overall dimension or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowPMILabel ( )

Returns the flag to indicate whether to show the PMI labels or not.


Created in NX12.0.2.

License requirements : None

bool NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::ShowVerticalFrameBar ( )

Returns the flag to indicate whether to show vertical frame bar or not.


Created in NX12.0.2.

License requirements : None

NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::FrameBarPositionType NXOpen::Features::ShipDesign::GeneralArrangement::DrawingViewItemBuilder::VerticalFrameBarPosition ( )

Returns the vertical frame bar position
Created in NX12.0.2.



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.