NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Features.ShipDesign.ShipNamesBuilder Class Reference

This class provides the mechanism for defining the names of Basic Design objects such as Decks, Bulkheads, Stiffener Systems, etc. More...

Inheritance diagram for NXOpen.Features.ShipDesign.ShipNamesBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe
NXOpen.Features.ShipDesign.ShipNameFieldBuilder 
GetField (int idx)
 Get the ShipNameField at the given index (starting at 0) More...
 
unsafe int GetFieldcount ()
 Get the number of ShipNameFields in this recipe 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 string ContextAttribute [get, set]
 Returns or sets the Context Attribute value. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipnamesBuilderType 
ShipObjectType [get, set]
 Returns or sets the Ship object type (Hull, Deck, etc. 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 the mechanism for defining the names of Basic Design objects such as Decks, Bulkheads, Stiffener Systems, etc.

Each Ship object type (Deck, etc.) has a specific format for the names defined in a "recipes" files located at UGII_BASE_DIR/nxship/data/ShipNamesRecipes.xml.

A recipe is composed of two or more "fields". Individual fields are defined via a NXOpen.Features.ShipDesign.ShipNameFieldBuilder object.

Created in NX9.0.0

Member Function Documentation

unsafe NXOpen.Features.ShipDesign.ShipNameFieldBuilder NXOpen.Features.ShipDesign.ShipNamesBuilder.GetField ( int  idx)
inline

Get the ShipNameField at the given index (starting at 0)

Created in NX9.0.2

License requirements: None.

Parameters
idx
Returns
unsafe int NXOpen.Features.ShipDesign.ShipNamesBuilder.GetFieldcount ( )
inline

Get the number of ShipNameFields in this recipe

Created in NX9.0.2

License requirements: None.

Returns
unsafe bool NXOpen.Features.ShipDesign.ShipNamesBuilder.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 string NXOpen.Features.ShipDesign.ShipNamesBuilder.ContextAttribute
getset

Returns or sets the Context Attribute value.

This is the value of the SAW_SUB_NAME part attribute added to the newly created / named Ship objects.

Created in NX9.0.2

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipnamesBuilderType NXOpen.Features.ShipDesign.ShipNamesBuilder.ShipObjectType
getset

Returns or sets the Ship object type (Hull, Deck, etc.

) for which names will be generated.

Created in NX9.0.2

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")


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