This class provides the mechanism for defining the names of Basic Design objects such as Decks, Bulkheads, Stiffener Systems, etc. More...
Public Member Functions | |
| NXString | ContextAttribute () |
| Returns the Context Attribute value. More... | |
| NXOpen::Features::ShipDesign::ShipNameFieldBuilder * | GetField (int idx) |
| Get the ShipNameField at the given index (starting at 0) More... | |
| int | GetFieldcount () |
| Get the number of ShipNameFields in this recipe. More... | |
| void | SetContextAttribute (const NXString &newValue) |
| Sets the Context Attribute value. More... | |
| void | SetContextAttribute (const char *newValue) |
| Sets the Context Attribute value. More... | |
| void | SetShipObjectType (NXOpen::Features::ShipDesign::ShipnamesBuilderType type) |
| Sets the Ship object type (Hull, Deck, etc.) for which names will be generated. More... | |
| NXOpen::Features::ShipDesign::ShipnamesBuilderType | ShipObjectType () |
| Returns the Ship object type (Hull, Deck, etc.) for which names will be generated. 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 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
| NXString NXOpen::Features::ShipDesign::ShipNamesBuilder::ContextAttribute | ( | ) |
Returns 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 : None
| NXOpen::Features::ShipDesign::ShipNameFieldBuilder* NXOpen::Features::ShipDesign::ShipNamesBuilder::GetField | ( | int | idx | ) |
Get the ShipNameField at the given index (starting at 0)
- Returns
Created in NX9.0.2.
License requirements : None
- Parameters
-
idx idx
| int NXOpen::Features::ShipDesign::ShipNamesBuilder::GetFieldcount | ( | ) |
Get the number of ShipNameFields in this recipe.
- Returns
Created in NX9.0.2.
License requirements : None
| void NXOpen::Features::ShipDesign::ShipNamesBuilder::SetContextAttribute | ( | const NXString & | newValue | ) |
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 : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
- Parameters
-
newValue newvalue
| void NXOpen::Features::ShipDesign::ShipNamesBuilder::SetContextAttribute | ( | const char * | newValue | ) |
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 : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
- Parameters
-
newValue newvalue
| void NXOpen::Features::ShipDesign::ShipNamesBuilder::SetShipObjectType | ( | NXOpen::Features::ShipDesign::ShipnamesBuilderType | type | ) |
Sets the Ship object type (Hull, Deck, etc.) for which names will be generated.
Created in NX9.0.2.
License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
- Parameters
-
type type
| NXOpen::Features::ShipDesign::ShipnamesBuilderType NXOpen::Features::ShipDesign::ShipNamesBuilder::ShipObjectType | ( | ) |
Returns the Ship object type (Hull, Deck, etc.) for which names will be generated.
Created in NX9.0.2.
License requirements : None
|
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:
- Features_ShipDesign_ShipNamesBuilder.hxx