NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::ShipDimensionBuilder Class Reference

Represents a NXOpen::Annotations::Dimension builder
To create a new instance of this class, use NXOpen::Annotations::ShipDimensionCollection::CreateShipDimensionBuilder

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Annotations::ShipDimensionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GroupType {
  GroupTypeMainShipItem, GroupTypeDecks, GroupTypeTransversalFrames, GroupTypeBulkheads,
  GroupTypeLongitudinalFrames
}
 The enum represents group type from concept model. More...
 

Public Member Functions

NXOpen::Annotations::AppendedTextBuilderAppendedText ()
 Returns the appended text
Created in NX9.0.0. More...
 
int Element ()
 Returns the element
Created in NX9.0.0. More...
 
NXString ElementName ()
 Returns the element name
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectFirstAssociativity ()
 Returns the first associativity
Created in NX9.0.0. More...
 
NXOpen::Annotations::ShipDimensionBuilder::GroupType Group ()
 Returns the group
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectInherit ()
 Returns the inherit
Created in NX9.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX9.0.0. More...
 
void SetElement (int element)
 Sets the element
Created in NX9.0.0. More...
 
void SetElementName (const NXString &elementName)
 Sets the element name
Created in NX9.0.0. More...
 
void SetElementName (const char *elementName)
 Sets the element name
Created in NX9.0.0. More...
 
void SetGroup (NXOpen::Annotations::ShipDimensionBuilder::GroupType group)
 Sets the group
Created in NX9.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX9.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::Annotations::Dimension builder
To create a new instance of this class, use NXOpen::Annotations::ShipDimensionCollection::CreateShipDimensionBuilder

Created in NX9.0.0.


Member Enumeration Documentation

The enum represents group type from concept model.

Enumerator
GroupTypeMainShipItem 

Group type MainShipItem.

GroupTypeDecks 

Group type Decks.

GroupTypeTransversalFrames 

Group type Transversal frames.

GroupTypeBulkheads 

Group type Bulkheads.

GroupTypeLongitudinalFrames 

Group type Longitudinal frames.

Member Function Documentation

NXOpen::Annotations::AppendedTextBuilder* NXOpen::Annotations::ShipDimensionBuilder::AppendedText ( )

Returns the appended text
Created in NX9.0.0.



License requirements : None

int NXOpen::Annotations::ShipDimensionBuilder::Element ( )

Returns the element
Created in NX9.0.0.



License requirements : None

NXString NXOpen::Annotations::ShipDimensionBuilder::ElementName ( )

Returns the element name
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::SelectDisplayableObject* NXOpen::Annotations::ShipDimensionBuilder::FirstAssociativity ( )

Returns the first associativity
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::ShipDimensionBuilder::GroupType NXOpen::Annotations::ShipDimensionBuilder::Group ( )

Returns the group
Created in NX9.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::ShipDimensionBuilder::Inherit ( )

Returns the inherit
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::ShipDimensionBuilder::Origin ( )

Returns the origin
Created in NX9.0.0.



License requirements : None

void NXOpen::Annotations::ShipDimensionBuilder::SetElement ( int  element)

Sets the element
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
elementelement
void NXOpen::Annotations::ShipDimensionBuilder::SetElementName ( const NXString elementName)

Sets the element name
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
elementNameelementname
void NXOpen::Annotations::ShipDimensionBuilder::SetElementName ( const char *  elementName)

Sets the element name
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
elementNameelementname
void NXOpen::Annotations::ShipDimensionBuilder::SetGroup ( NXOpen::Annotations::ShipDimensionBuilder::GroupType  group)

Sets the group
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
groupgroup
NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::ShipDimensionBuilder::Style ( )

Returns the style
Created in NX9.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.