NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void ResetNameList ()
 Sets the current list of NXOpen.Features.ShipDesign.ShipNamesBuilder objects to be empty. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipNamesBuilder[] 
SetObjectTypes (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...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Features.ShipDesign.ShipNamesBuilderList 
ShipNamesList [get]
 Returns the list of ShipNamesBuilder objects More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

unsafe void NXOpen.Features.ShipDesign.ShipNamesListBuilder.ResetNameList ( )
inline

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.

unsafe NXOpen.Features.ShipDesign.ShipNamesBuilder [] NXOpen.Features.ShipDesign.ShipNamesListBuilder.SetObjectTypes ( NXOpen.NXObject[]  objects)
inline

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.

Created in NX10.0.0

License requirements: nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters
objects
Returns
unsafe bool NXOpen.Features.ShipDesign.ShipNamesListBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Features.ShipDesign.ShipNamesBuilderList NXOpen.Features.ShipDesign.ShipNamesListBuilder.ShipNamesList
get

Returns the list of ShipNamesBuilder objects

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