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
std::vector< NXString >	GetOptionValues ()
	Get the valid option values for an Option type field. More...
void	SetValue (const NXString &newValue)
	Sets the field value. More...
void	SetValue (const char *newValue)
	Sets the field value. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
NXString	Value ()
	Returns the field value. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

std::vector<NXString> NXOpen::Features::ShipDesign::ShipNameFieldBuilder::GetOptionValues

(

)

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

Returns

Created in NX9.0.2.

License requirements : None

void NXOpen::Features::ShipDesign::ShipNameFieldBuilder::SetValue

(

const NXString &

newValue

)

Sets the field value.

Created in NX9.0.2.

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

Parameters

newValue

newvalue

void NXOpen::Features::ShipDesign::ShipNameFieldBuilder::SetValue

(

const char *

newValue

)

Sets the field value.

Created in NX9.0.2.

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

Parameters

newValue

newvalue

virtual bool NXOpen::Features::ShipDesign::ShipNameFieldBuilder::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.

NXString NXOpen::Features::ShipDesign::ShipNameFieldBuilder::Value

(

)

Returns the field value.

Created in NX9.0.2.

License requirements : None

---

The documentation for this class was generated from the following file:

• Features_ShipDesign_ShipNameFieldBuilder.hxx