Represents a NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder builder. More...

Inheritance diagram for NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder:

Public Member Functions
void	CacheSpreadsheetData ()
	This method caches parameter data from spreadsheet to the builder. More...

void	DeleteImportedSketch ()
	This method deletes the imported sketch which is unwanted any longer. More...

void	EditParameter (const NXString &parameterName, const NXString &parameterValue)
	This method simply changes the value of a parameter. More...

void	EditParameter (const char parameterName, const char parameterValue)
	This method simply changes the value of a parameter. More...

void	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. More...

void	EditPrimaryParameter (const char parameterName, const char parameterValue)
	This method changes the value of a parameter and queries from the spread sheet to update the related parameter values. More...

std::vector< NXString >	GetAvailableSectionTypes ()
	This method finds the available section types for the current context data. More...

std::vector < NXOpen::Features::Feature * >	GetImportedSketches ()
	This method retrieves all the features that are imported into current work part. More...

std::vector < NXOpen::Tooling::SpreadsheetDataParameter * >	GetParameterValues ()
	This method retrieves all the parameter values related to the current imported sketch template. More...

NXOpen::Tooling::SpreadsheetData *	GetSpreadsheetData ()
	It retrieves the KRUSpreadsheetData object to the builder. More...

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. More...

void	ResetBuilderData ()
	This method cleans up the imported features from current work part, also it rereads the data file and registration. More...

void	RestoreSpreadsheetData ()
	This method restores parameter data inside the builder. More...

int	SectionType ()
	Returns the section type More...

void	SetContextEntity (NXOpen::TaggedObject *contextEntity)
	Set the context entity on which the context attribute is stored. More...

void	SetPossibleContextAttribute (int possibleContextAttributeIndex, const NXString &possibleContextAttribute)
	Set a possible context attribute (assuming the context entity has not yet been created). More...

void	SetPossibleContextAttribute (int possibleContextAttributeIndex, const char *possibleContextAttribute)
	Set a possible context attribute (assuming the context entity has not yet been created). More...

void	SetPossibleContextAttributeCount (int possibleContextAttributeCount)
	Set the possible context attribute count (assuming the context entity has not yet been created). More...

void	SetRuleInputs (std::vector< NXString > &inputNames, std::vector< NXString > &inputValues)
	This method sets the rule inputs. More...

void	SetsDefaultTypesFromContext ()
	Set default section types of the builder when a new context entity is set. More...

void	SetSectionSubType1 (const NXString &strSectionType)
	Sets the section sub type by string value. More...

void	SetSectionSubType1 (const char *strSectionType)
	Sets the section sub type by string value. More...

void	SetSectionSubType2 (const NXString &strSectionType)
	Sets the section sub type2 by string value. More...

void	SetSectionSubType2 (const char *strSectionType)
	Sets the section sub type2 by string value. More...

void	SetSectionType (int nSectionType)
	Sets the section type More...

void	SetSectionType (const NXString &strSectionType)
	This method sets the section type outside the block. More...

void	SetSectionType (const char *strSectionType)
	This method sets the section type outside the block. More...

void	SetSpreadsheetData (NXOpen::Tooling::SpreadsheetData *pKRUData)
	It sets the KRUSpreadsheetData object to the builder. More...

void	SetSteelFeatureType (const NXString &steelFeatureType)
	Sets the steel feature type (eg: Profile, Edge Reinforcement, etc) More...

void	SetSteelFeatureType (const char *steelFeatureType)
	Sets the steel feature type (eg: Profile, Edge Reinforcement, etc) More...

NXString	SteelFeatureType ()
	Returns the steel feature type (eg: Profile, Edge Reinforcement, etc) More...

void	UpdateParametersUsingRules ()
	This method updates the parameters in the steel feature data spreadsheet using parameters rules. More...

void	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. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Represents a NXOpen::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.

Member Function Documentation

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::CacheSpreadsheetData ( )

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::DeleteImportedSketch ( )

This method deletes the imported sketch which is unwanted any longer.

Created in NX12.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")

Parameters

parameterName	the parameter name
parameterValue	the parameter value

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::EditParameter	(	const char *	parameterName,
		const char *	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")

Parameters

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

Parameters

parameterName	the parameter name
parameterValue	the parameter value

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::EditPrimaryParameter	(	const char *	parameterName,
		const char *	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")

Parameters

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.

Returns: Array of available section types
Created in NX8.0.0.

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

std::vector<NXOpen::Features::Feature *> NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetImportedSketches ( )

This method retrieves all the features that are imported into current work part.

Returns: Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::Tooling::SpreadsheetDataParameter *> NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetParameterValues ( )

This method retrieves all the parameter values related to the current imported sketch template.

Returns: Array of structures with the parameter data.
Created in NX8.0.0.

License requirements : None

NXOpen::Tooling::SpreadsheetData* NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::GetSpreadsheetData ( )

It retrieves the KRUSpreadsheetData object to the builder.

In most cases, this method is used internally.

Returns: Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::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.

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::ResetBuilderData ( )

This method cleans up the imported features from current work part, also it rereads the data file and registration.

If UI is concerned, UpdateDlgLayout should be called in UI.

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::RestoreSpreadsheetData ( )

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

int NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SectionType ( )

Returns the section type

Deprecated:: Deprecated in NX8.5.0.

Removed with no replacement

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

Parameters

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

Parameters

possibleContextAttributeIndex	the index into the possible context attribute array we wish to set
possibleContextAttribute	possiblecontextattribute

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetPossibleContextAttribute	(	int	possibleContextAttributeIndex,
		const char *	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")

Parameters

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

Parameters

possibleContextAttributeCount the number of possible context attributes (use this before setting each possible context attribute via SetPossibleContextAttribute)

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetRuleInputs	(	std::vector< NXString > &	inputNames,
		std::vector< NXString > &	inputValues
	)

This method sets the rule inputs.

The rule inputs will be used to evaluate the section rules and parameter rules defined in xml rule file. Ensure the inputs have been clearly described as comment in the xml rule file, so the user can use them when they want to modify the rules.

Created in NX9.0.0.

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

Parameters

inputNames	inputnames
inputValues	inputvalues

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetsDefaultTypesFromContext ( )

Set default section types of the builder when a new context entity is set.

Created in NX8.5.1.

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

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionSubType1 ( const NXString & strSectionType )

Sets the section sub type by string value.

Created in NX8.5.1.

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

Parameters

strSectionType strsectiontype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionSubType1 ( const char * strSectionType )

Sets the section sub type by string value.

Created in NX8.5.1.

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

Parameters

strSectionType strsectiontype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionSubType2 ( const NXString & strSectionType )

Sets the section sub type2 by string value.

Created in NX8.5.1.

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

Parameters

strSectionType strsectiontype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionSubType2 ( const char * strSectionType )

Sets the section sub type2 by string value.

Created in NX8.5.1.

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

Parameters

strSectionType strsectiontype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionType ( int nSectionType )

Sets the section type

Deprecated:: Deprecated in NX8.5.0.

Use NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder .SetSectionType()

Created in NX8.0.0.

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

Parameters

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

Parameters

strSectionType strsectiontype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSectionType ( const char * 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")

Parameters

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

Parameters

pKRUData pkrudata

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSteelFeatureType ( const NXString & steelFeatureType )

Sets the steel feature type (eg: Profile, Edge Reinforcement, etc)

Created in NX8.0.0.

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

Parameters

steelFeatureType steelfeaturetype

void NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SetSteelFeatureType ( const char * steelFeatureType )

Sets the steel feature type (eg: Profile, Edge Reinforcement, etc)

Created in NX8.0.0.

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

Parameters

steelFeatureType steelfeaturetype

NXString NXOpen::Features::ShipDesign::SteelFeatureSpreadsheetBuilder::SteelFeatureType ( )

Returns the steel feature type (eg: Profile, Edge Reinforcement, etc)

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::UpdateParametersUsingRules ( )

This method updates the parameters in the steel feature data spreadsheet using parameters rules.

The rule inputs should be set before you call this method.

Created in NX9.0.0.

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

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

Parameters

paramNames	paramnames
paramValues	paramvalues

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

Features_ShipDesign_SteelFeatureSpreadsheetBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation