NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder Class Reference

Represents the standard part framework builder to add or edit ship standard part. More...

Inheritance diagram for NXOpen::Features::ShipDesign::StandardPartFrameworkBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::StandardPartItemBuilderCreateStandardPartItem (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::StandardPartItemBuilderStandardPartItem ()
 Returns the standard part item, which is the builder of the selection item.
NXOpen::Features::ShipDesign::StandardPartItemBuilderListStandardPartList ()
 Returns the standard part list, which supports to add more than one standard part at one time.
NXOpen::ExpressionThickness ()
 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::CharacteristicsBuilderWeldCharacteristics ()
 Returns the weld characteristics.

Detailed Description

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.


Member Enumeration Documentation

Indicates the stage of the smart rule.

Enumerator:
SmartRuleStagePreUpdate 

In pre-update stage.

SmartRuleStagePostUpdate 

In post-update stage.


Member Function Documentation

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")

Parameters:
pStrParamNamepstrparamname
pStrParamValuepstrparamvalue

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")

Parameters:
pItemBuilderpitembuilder
ppStrParamNameppstrparamname
ppStrParamValueppstrparamvalue

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.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
refBuilderrefbuilder

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")

Parameters:
pItemBuilderpitembuilder

Returns the first compartment option.


Created in NX8.0.0.

License requirements : None

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")

Parameters:
bUpdateModelbupdatemodel

Retrieves the data file name from the registration spread sheet.


Created in NX8.0.0.

License requirements : None

Parameters:
updateConfigurationWhether to update the selection configuration

Retrieves the model file name from the registration spread sheet.

Returns:

Created in NX8.0.0.

License requirements : None

Returns the default name of the added standard part name.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
bFullNamebfullname
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")

Parameters:
strParamNamestrparamname
strParamValuestrparamvalue

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

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")

Parameters:
itemBuilderitembuilder

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")

Parameters:
pItemBuilderpitembuilder
stagestage
ppStrParamNameppstrparamname
ppStrParamValueppstrparamvalue
ppStrParamDescriptionppstrparamdescription

Returns the second compartment option.


Created in NX8.0.0.

License requirements : None

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")

Parameters:
strConfigAttrstrconfigattr

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")

Parameters:
firstOptionfirstoption

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")

Parameters:
partTypeparttype

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")

Parameters:
partLeafTypepartleaftype

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")

Parameters:
partSubTypepartsubtype

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")

Parameters:
reverseDirectionOptionreversedirectionoption

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")

Parameters:
secondOptionsecondoption

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")

Parameters:
stdPartGroupOptionstdpartgroupoption

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

Returns the standard part item, which is the builder of the selection item.


Created in NX8.0.0.

License requirements : None

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")

Parameters:
strParamNamestrparamname
strParamValuestrparamvalue
pnParamStatuspnparamstatus

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")

Parameters:
bUpdateModelbupdatemodel

Returns the weld characteristics.


Created in NX8.0.0.

License requirements : None


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