NXOpen.Features.ShipDesign.ShipNameFieldBuilder Class Reference

A field, combined with other fields, to generate a name for a Ship Basic Design Object such as a Deck. More...

Inheritance diagram for NXOpen.Features.ShipDesign.ShipNameFieldBuilder:

Public Member Functions
unsafe string[]	GetOptionValues ()
	Get the valid option values for an Option type field. 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	Value [get, set]
	Returns or sets the field value. 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

A field, combined with other fields, to generate a name for a Ship Basic Design Object such as a Deck.

The ShipNameFieldBuilder class contains the information used to generate a name for a Basic Design object, such as a Deck, Bulkhead, Stiffener System, etc.

Fields can be one of four types: 
    1) Fixed            A string with an unchangeable value 
    2) Any              A user entered string value 
    3) Option           A predefined set of strings from which the user can choose one 
    4) Index            A system generated, leading zeros, number which pretends to provide 
                        name uniqueness. 

There may be as many Fixed, Any, and Option fields as the user deems appropriate. There may be only one Index field.

The fields for a particular Ship object type NXOpen.Features.ShipDesign.ShipNamesBuilder are defined in a "recipes" file which specifies, for a particular object type, the fields and their values. See ShipNamesRecipes.xml in UGII_BASE_DIR/nxship/data for details on the recipes.

A sample recipe might be defined having the following fields: 

    Type            Value 
    --------        -------- 
    Fixed           "TBH-" 
    Option          "Port", "Starboard", "None" 
    Fixed           "-" 
    Index           nnnnnn

This is an abstract class and cannot be instantiated

Created in NX9.0.2

Member Function Documentation

unsafe string [] NXOpen.Features.ShipDesign.ShipNameFieldBuilder.GetOptionValues ( )

inline

Get the valid option values for an Option type field.

No values are returned (and the count is set to zero) if this is not an option field

Created in NX9.0.2

License requirements: None.

Returns

unsafe bool NXOpen.Features.ShipDesign.ShipNameFieldBuilder.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.ShipNameFieldBuilder.Value

getset

Returns or sets the field value.

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:

• Features_ShipDesign_ShipNameFieldBuilder.cs