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

This class provides a list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects. More...

Inheritance diagram for NXOpen::Features::ShipDesign::ShipNamesListBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void ResetNameList ()
 Sets the current list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects to be empty. More...
 
std::vector
< NXOpen::Features::ShipDesign::ShipNamesBuilder * > 
SetObjectTypes (const std::vector< NXOpen::NXObject * > &objects)
 Sets the current list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects to the types determined by the types of the supplied objects. More...
 
NXOpen::Features::ShipDesign::ShipNamesBuilderListShipNamesList ()
 Returns the list of ShipNamesBuilder objects
Created in NX9.0.2. 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 class provides a list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects.

A ShipNamesBuilder provides the data necessary to generate names for new Ship objects, such as Decks, Bulkheads, etc. So the ShipNamesListBuilder is a means for defining and modifying ShipNamesBuilders for multiple types of Ship objects. For example, in copying or mirroring Ship content, it is necessary to have a ShipNamesBuilder for each type of Ship object being copied / mirrored.
This is an abtract class. It cannot be instantiated.

Created in NX9.0.2.

Member Function Documentation

void NXOpen::Features::ShipDesign::ShipNamesListBuilder::ResetNameList ( )

Sets the current list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects to be empty.

Returned will be error code.


Created in NX10.0.0.

License requirements : None

std::vector<NXOpen::Features::ShipDesign::ShipNamesBuilder *> NXOpen::Features::ShipDesign::ShipNamesListBuilder::SetObjectTypes ( const std::vector< NXOpen::NXObject * > &  objects)

Sets the current list of NXOpen::Features::ShipDesign::ShipNamesBuilder objects to the types determined by the types of the supplied objects.

For example, if within objects, there is a Deck and 2 Tranverse Bulkheads, then the list of NXOpen::Features::ShipDesign::ShipNamesBuilder builders will have Deck and Tranverse Bulkhead builders added (if they are not there already).

Returned will be the number and pointers to any new builders added.

Returns

Created in NX10.0.0.

License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
Parameters
objectsobjects
NXOpen::Features::ShipDesign::ShipNamesBuilderList* NXOpen::Features::ShipDesign::ShipNamesListBuilder::ShipNamesList ( )

Returns the list of ShipNamesBuilder objects
Created in NX9.0.2.



License requirements : None

virtual bool NXOpen::Features::ShipDesign::ShipNamesListBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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