NX Open C++ Reference Guide
|
Represents the standard part framework builder to add or edit ship standard part. More...
Public Types | |
enum | SmartRuleStage { SmartRuleStagePreUpdate, SmartRuleStagePostUpdate } |
Indicates the stage of the smart rule. More... | |
Public Member Functions | |
void | AddStandardPart () |
Adds a standard part into the assembly context, restores the broken wave links and renames the standard part when all external references are defined. | |
void | ApplySmartRuleResult (std::vector< NXString > &pStrParamName, std::vector< NXString > &pStrParamValue) |
Applies the smart rule results to the spreadsheet data block. | |
void | CheckInterference () |
Checks the clearance between the standard parts and the other components in current assembly. | |
void | CheckSpreadsheetInput (NXOpen::Features::ShipDesign::StandardPartItemBuilder *pItemBuilder, std::vector< NXString > &ppStrParamName, std::vector< NXString > &ppStrParamValue) |
Looks for the parameter values that are owned by reference geometeries(Attributes) and/or template parts(attributes or expressions) and used as inputs to look for the parameter values in spreadsheet. | |
NXString | ConfigAttribute () |
Returns the configure attribute, which is read from the design environment by the settings in the configuration XML file. | |
NXOpen::Features::ShipDesign::StandardPartItemBuilder * | CreateStandardPartItem (NXOpen::Features::ShipDesign::StandardPartItemBuilder *refBuilder) |
Creates a new StandardPartItemBuilder and intialize the builder with data from the reference builder. | |
void | EndRunSmartRule (NXOpen::Features::ShipDesign::StandardPartItemBuilder *pItemBuilder) |
End run the smart rules. | |
NXString | FirstCompartment () |
Returns the first compartment option. | |
void | FlipThicknessDirection (bool bUpdateModel) |
Flips the standard part thickness direction. | |
void | GetDataFile (bool updateConfiguration) |
Retrieves the data file name from the registration spread sheet. | |
NXString | GetModelFile () |
Retrieves the model file name from the registration spread sheet. | |
NXString | GetStandardPartName (bool bFullName) |
Returns the default name of the added standard part name. | |
void | ModifySpreadsheetData (std::vector< NXString > &strParamName, std::vector< NXString > &strParamValue) |
Modifies specific parameter values without change parameter statuses. | |
NXString | PartCategory () |
Returns the part category, which is defined in registration file. | |
NXString | PartSubType () |
Returns the part sub type, which is the sub category of sub type. | |
NXString | PartType () |
Returns the part type, which is the sub category of part type. | |
void | PostUpdate () |
Does the final check to finish the process of updating standar parts. | |
void | RemoveInstance (NXOpen::Features::ShipDesign::StandardPartItemBuilder *itemBuilder) |
Removes the standard part instance. | |
void | ResetRuleInputCache () |
Resets rule trigger source cache so the rule trigger evaluation can start from original point. | |
bool | ReverseDirection () |
Returns the option whether to reverse direction. | |
void | RunSmartRule (NXOpen::Features::ShipDesign::StandardPartItemBuilder *pItemBuilder, NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SmartRuleStage stage, std::vector< NXString > &ppStrParamName, std::vector< NXString > &ppStrParamValue, std::vector< NXString > &ppStrParamDescription) |
Runs the smart rule engine to get the inference result. | |
NXString | SecondCompartment () |
Returns the second compartment option. | |
void | SetConfigAttribute (const NXString &strConfigAttr) |
Sets the configure attribute, which is read from the design environment by the settings in the configuration XML file. | |
void | SetFirstCompartment (const NXString &firstOption) |
Sets the first compartment option. | |
void | SetPartCategory (const NXString &partType) |
Sets the part category, which is defined in registration file. | |
void | SetPartSubType (const NXString &partLeafType) |
Sets the part sub type, which is the sub category of sub type. | |
void | SetPartType (const NXString &partSubType) |
Sets the part type, which is the sub category of part type. | |
void | SetReverseDirection (bool reverseDirectionOption) |
Sets the option whether to reverse direction. | |
void | SetSecondCompartment (const NXString &secondOption) |
Sets the second compartment option. | |
void | SetStandardPartGroupOption (bool stdPartGroupOption) |
Sets the option whether to group multiple standard parts together to share the same parameters during the update when editing. | |
void | SetView () |
Sets the current view normal to the main plane, which is the base plane to construct the primary sketch in the template part. | |
bool | StandardPartGroupOption () |
Returns the option whether to group multiple standard parts together to share the same parameters during the update when editing. | |
NXOpen::Features::ShipDesign::StandardPartItemBuilder * | StandardPartItem () |
Returns the standard part item, which is the builder of the selection item. | |
NXOpen::Features::ShipDesign::StandardPartItemBuilderList * | StandardPartList () |
Returns the standard part list, which supports to add more than one standard part at one time. | |
NXOpen::Expression * | Thickness () |
Returns the standard part thickness. | |
void | UpdateModel () |
Updates all standard parts. | |
void | UpdateSpreadsheetData (std::vector< NXString > &strParamName, std::vector< NXString > &strParamValue, const std::vector< int > &pnParamStatus) |
Updates the parameter values which are defined in the parameter spreadsheet. | |
void | UpdateThickness (bool bUpdateModel) |
Updates the user input thickness to the standard parts. | |
NXOpen::Weld::CharacteristicsBuilder * | WeldCharacteristics () |
Returns the weld characteristics. |
Represents the standard part framework builder to add or edit ship standard part.
To create a new instance of this class, use Features::ShipCollection::CreateStandardPartFrameworkBuilder
Default values.
Property | Value |
---|---|
Thickness.Value |
5 (millimeters part), 0.02 (inches part) |
Created in NX8.0.0.
Adds a standard part into the assembly context, restores the broken wave links and renames the standard part when all external references are defined.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::ApplySmartRuleResult | ( | std::vector< NXString > & | pStrParamName, |
std::vector< NXString > & | pStrParamValue | ||
) |
Applies the smart rule results to the spreadsheet data block.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
pStrParamName | pstrparamname |
pStrParamValue | pstrparamvalue |
Checks the clearance between the standard parts and the other components in current assembly.
There are two types of interference to be checked. 1) Interference between standard part and other componenets, and 2) interference between standard part and cutouts.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::CheckSpreadsheetInput | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder * | pItemBuilder, |
std::vector< NXString > & | ppStrParamName, | ||
std::vector< NXString > & | ppStrParamValue | ||
) |
Looks for the parameter values that are owned by reference geometeries(Attributes) and/or template parts(attributes or expressions) and used as inputs to look for the parameter values in spreadsheet.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
pItemBuilder | pitembuilder |
ppStrParamName | ppstrparamname |
ppStrParamValue | ppstrparamvalue |
Returns the configure attribute, which is read from the design environment by the settings in the configuration XML file.
Created in NX8.0.0.
License requirements : None
Creates a new StandardPartItemBuilder and intialize the builder with data from the reference builder.
refBuilder | refbuilder |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::EndRunSmartRule | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder * | pItemBuilder | ) |
End run the smart rules.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
pItemBuilder | pitembuilder |
Returns the first compartment option.
Created in NX8.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::FlipThicknessDirection | ( | bool | bUpdateModel | ) |
Flips the standard part thickness direction.
If bUpdateModel is true, the model will be updated. If it is false, the thickness direction will be flipped but the model will not be updated.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
bUpdateModel | bupdatemodel |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::GetDataFile | ( | bool | updateConfiguration | ) |
Retrieves the data file name from the registration spread sheet.
Created in NX8.0.0.
License requirements : None
updateConfiguration | Whether to update the selection configuration |
Retrieves the model file name from the registration spread sheet.
NXString NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::GetStandardPartName | ( | bool | bFullName | ) |
Returns the default name of the added standard part name.
bFullName | bfullname |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::ModifySpreadsheetData | ( | std::vector< NXString > & | strParamName, |
std::vector< NXString > & | strParamValue | ||
) |
Modifies specific parameter values without change parameter statuses.
This could be used to apply smart rule result.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
strParamName | strparamname |
strParamValue | strparamvalue |
Returns the part category, which is defined in registration file.
The typical standard part types include stiffener end bracket, collar plate, tripping bracket, flat bar etc.
Created in NX8.0.0.
License requirements : None
Returns the part sub type, which is the sub category of sub type.
Created in NX8.0.0.
License requirements : None
Returns the part type, which is the sub category of part type.
Created in NX8.0.0.
License requirements : None
Does the final check to finish the process of updating standar parts.
Created in NX8.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::RemoveInstance | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder * | itemBuilder | ) |
Removes the standard part instance.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
itemBuilder | itembuilder |
Resets rule trigger source cache so the rule trigger evaluation can start from original point.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
Returns the option whether to reverse direction.
Created in NX8.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::RunSmartRule | ( | NXOpen::Features::ShipDesign::StandardPartItemBuilder * | pItemBuilder, |
NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SmartRuleStage | stage, | ||
std::vector< NXString > & | ppStrParamName, | ||
std::vector< NXString > & | ppStrParamValue, | ||
std::vector< NXString > & | ppStrParamDescription | ||
) |
Runs the smart rule engine to get the inference result.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
pItemBuilder | pitembuilder |
stage | stage |
ppStrParamName | ppstrparamname |
ppStrParamValue | ppstrparamvalue |
ppStrParamDescription | ppstrparamdescription |
Returns the second compartment option.
Created in NX8.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetConfigAttribute | ( | const NXString & | strConfigAttr | ) |
Sets the configure attribute, which is read from the design environment by the settings in the configuration XML file.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
strConfigAttr | strconfigattr |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetFirstCompartment | ( | const NXString & | firstOption | ) |
Sets the first compartment option.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
firstOption | firstoption |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetPartCategory | ( | const NXString & | partType | ) |
Sets the part category, which is defined in registration file.
The typical standard part types include stiffener end bracket, collar plate, tripping bracket, flat bar etc.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
partType | parttype |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetPartSubType | ( | const NXString & | partLeafType | ) |
Sets the part sub type, which is the sub category of sub type.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
partLeafType | partleaftype |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetPartType | ( | const NXString & | partSubType | ) |
Sets the part type, which is the sub category of part type.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
partSubType | partsubtype |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetReverseDirection | ( | bool | reverseDirectionOption | ) |
Sets the option whether to reverse direction.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
reverseDirectionOption | reversedirectionoption |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetSecondCompartment | ( | const NXString & | secondOption | ) |
Sets the second compartment option.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
secondOption | secondoption |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::SetStandardPartGroupOption | ( | bool | stdPartGroupOption | ) |
Sets the option whether to group multiple standard parts together to share the same parameters during the update when editing.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
stdPartGroupOption | stdpartgroupoption |
Sets the current view normal to the main plane, which is the base plane to construct the primary sketch in the template part.
If there is no sketch found, nothing will be done.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
Returns the option whether to group multiple standard parts together to share the same parameters during the update when editing.
Created in NX8.0.0.
License requirements : None
NXOpen::Features::ShipDesign::StandardPartItemBuilder* NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::StandardPartItem | ( | ) |
Returns the standard part item, which is the builder of the selection item.
Created in NX8.0.0.
License requirements : None
NXOpen::Features::ShipDesign::StandardPartItemBuilderList* NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::StandardPartList | ( | ) |
Returns the standard part list, which supports to add more than one standard part at one time.
Created in NX8.0.0.
License requirements : None
Returns the standard part thickness.
Created in NX8.0.0.
License requirements : None
Updates all standard parts.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::UpdateSpreadsheetData | ( | std::vector< NXString > & | strParamName, |
std::vector< NXString > & | strParamValue, | ||
const std::vector< int > & | pnParamStatus | ||
) |
Updates the parameter values which are defined in the parameter spreadsheet.
It also updates the standard parts.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
strParamName | strparamname |
strParamValue | strparamvalue |
pnParamStatus | pnparamstatus |
void NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::UpdateThickness | ( | bool | bUpdateModel | ) |
Updates the user input thickness to the standard parts.
If bUpdateModel is true, the model will be updated. If it is false, the thickness value will be changed but the model will not be updated.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
bUpdateModel | bupdatemodel |
NXOpen::Weld::CharacteristicsBuilder* NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder::WeldCharacteristics | ( | ) |
Returns the weld characteristics.
Created in NX8.0.0.
License requirements : None