NX Open C++ Reference Guide
|
Represents a Features::ShipDesign::SteelFeatureSpreadsheetBuilder builder. More...
Public Member Functions | |
void | CacheSpreadsheetData () |
This method caches parameter data from spreadsheet to the builder. | |
void | EditParameter (const NXString ¶meterName, const NXString ¶meterValue) |
This method simply changes the value of a parameter. | |
void | EditPrimaryParameter (const NXString ¶meterName, const NXString ¶meterValue) |
This method changes the value of a parameter and queries from the spread sheet to update the related parameter values. | |
std::vector< NXString > | GetAvailableSectionTypes () |
This method finds the available section types for the current context data. | |
std::vector < NXOpen::Features::Feature * > | GetImportedSketches () |
This method retrieves all the features that are imported into current work part. | |
std::vector < NXOpen::Tooling::SpreadsheetDataParameter * > | GetParameterValues () |
This method retrieves all the parameter values related to the current imported sketch template. | |
NXOpen::Tooling::SpreadsheetData * | GetSpreadsheetData () |
It retrieves the KRUSpreadsheetData object to the builder. | |
void | ImportSketch () |
Thie method reads the model file name from the spread sheet, imports the sketch template into current work part, and updates the attribute values and expresseion values from the data spreadsheet. | |
void | ResetBuilderData () |
This method cleans up the imported features from current work part, also it rereads the data file and registration. | |
void | RestoreSpreadsheetData () |
This method restores parameter data inside the builder. | |
int | SectionType () |
Returns the section type Created in NX8.0.0. | |
void | SetContextEntity (NXOpen::TaggedObject *contextEntity) |
Set the context entity on which the context attribute is stored. | |
void | SetPossibleContextAttribute (int possibleContextAttributeIndex, const NXString &possibleContextAttribute) |
Set a possible context attribute (assuming the context entity has not yet been created). | |
void | SetPossibleContextAttributeCount (int possibleContextAttributeCount) |
Set the possible context attribute count (assuming the context entity has not yet been created). | |
void | SetSectionType (int nSectionType) |
Sets the section type Created in NX8.0.0. | |
void | SetSectionType (const NXString &strSectionType) |
This method sets the section type outside the block. | |
void | SetSpreadsheetData (NXOpen::Tooling::SpreadsheetData *pKRUData) |
It sets the KRUSpreadsheetData object to the builder. | |
void | SetSteelFeatureType (const NXString &steelFeatureType) |
Sets the steel feature type (eg: Profile, Edge Reinforcement, etc) | |
NXString | SteelFeatureType () |
Returns the steel feature type (eg: Profile, Edge Reinforcement, etc) | |
void | UpdateSpreadsheetData (std::vector< NXString > ¶mNames, std::vector< NXString > ¶mValues) |
This method takes parameter name and parameter value pairs as input and updates the related geometries by updating the expressions, i.e. |
Represents a Features::ShipDesign::SteelFeatureSpreadsheetBuilder builder.
It is used to manage the data contained in the ship sketch based steel feature block.
This class is sub-object of another builder, and cannot be directly instantiated.
Created in NX8.0.0.
This method caches parameter data from spreadsheet to the builder.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::EditParameter | ( | const NXString & | parameterName, |
const NXString & | parameterValue | ||
) |
This method simply changes the value of a parameter.
Parameter could be an expression or an attribute. Also a call to UI method UpdateDlgLayout is needed afterwards if UI is concerned.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
parameterName | the parameter name |
parameterValue | the parameter value |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::EditPrimaryParameter | ( | const NXString & | parameterName, |
const NXString & | parameterValue | ||
) |
This method changes the value of a parameter and queries from the spread sheet to update the related parameter values.
A call to UI method UpdateDlgLayout is needed afterwards if UI is concerned.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
parameterName | the parameter name |
parameterValue | the parameter value |
std::vector<NXString> NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetAvailableSectionTypes | ( | ) |
This method finds the available section types for the current context data.
It will do lookups in the registration file to see which context attribute in the table matches the current possible context attributes or the current context entitie's attributes. Then it repopulates the list of available section types that are used with the current context attribute. All of these table lookups can be expensive for performance.
std::vector<NXOpen::Features::Feature *> NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetImportedSketches | ( | ) |
This method retrieves all the features that are imported into current work part.
std::vector<NXOpen::Tooling::SpreadsheetDataParameter *> NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetParameterValues | ( | ) |
This method retrieves all the parameter values related to the current imported sketch template.
NXOpen::Tooling::SpreadsheetData* NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetSpreadsheetData | ( | ) |
It retrieves the KRUSpreadsheetData object to the builder.
In most cases, this method is used internally.
Thie method reads the model file name from the spread sheet, imports the sketch template into current work part, and updates the attribute values and expresseion values from the data spreadsheet.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
This method restores parameter data inside the builder.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
Returns the section type
Created in NX8.0.0.
License requirements : None
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetContextEntity | ( | NXOpen::TaggedObject * | contextEntity | ) |
Set the context entity on which the context attribute is stored.
For example, if you're spreadsheet builder is being used to create an endcut, the body you're about to cut should be set as the context entity. Refer to the individual feature's documentation to see what context entity is expected for the feature you're using.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
contextEntity | contextentity |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetPossibleContextAttribute | ( | int | possibleContextAttributeIndex, |
const NXString & | possibleContextAttribute | ||
) |
Set a possible context attribute (assuming the context entity has not yet been created).
If you have any possible context attributes set in this builder, the context entity will be ignored, and the context attribute will be selected from the list of possible context attributes.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
possibleContextAttributeIndex | the index into the possible context attribute array we wish to set |
possibleContextAttribute | possiblecontextattribute |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetPossibleContextAttributeCount | ( | int | possibleContextAttributeCount | ) |
Set the possible context attribute count (assuming the context entity has not yet been created).
If you have any possible context attributes set in this builder, the context entity will be ignored, and the context attribute will be selected from the list of possible context attributes.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
possibleContextAttributeCount | the number of possible context attributes (use this before setting each possible context attribute via SetPossibleContextAttribute) |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionType | ( | int | nSectionType | ) |
Sets the section type
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
nSectionType | nsectiontype |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionType | ( | const NXString & | strSectionType | ) |
This method sets the section type outside the block.
It provides a way for the block user to set up the section type by a string value. the block will look up the registration spreadsheet to translate it into number value.
Created in NX8.0.0.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
strSectionType | strsectiontype |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSpreadsheetData | ( | NXOpen::Tooling::SpreadsheetData * | pKRUData | ) |
It sets the KRUSpreadsheetData object to the builder.
In most cases, this method is used internally.
Created in NX8.0.0.
License requirements : None
pKRUData | pkrudata |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSteelFeatureType | ( | const NXString & | steelFeatureType | ) |
void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::UpdateSpreadsheetData | ( | std::vector< NXString > & | paramNames, |
std::vector< NXString > & | paramValues | ||
) |
This method takes parameter name and parameter value pairs as input and updates the related geometries by updating the expressions, i.e.
sketches.
Created in NX8.0.1.
License requirements : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")
paramNames | paramnames |
paramValues | paramvalues |