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

Inheritance diagram for NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder:

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

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

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

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

unsafe string[]	GetAvailableSectionTypes ()
	This method finds the available section types for the current context data. More...

unsafe NXOpen.Features.Feature[]	GetImportedSketches ()
	This method retrieves all the features that are imported into current work part. More...

unsafe NXOpen.Tooling.SpreadsheetDataParameter[]	GetParameterValues ()
	This method retrieves all the parameter values related to the current imported sketch template. More...

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

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

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

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

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

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

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

unsafe void	SetRuleInputs (string[] inputNames, string[] inputValues)
	This method sets the rule inputs. More...

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

unsafe void	SetSectionSubType1 (string strSectionType)
	Sets the section sub type by string value. More...

unsafe void	SetSectionSubType2 (string strSectionType)
	Sets the section sub type2 by string value. More...

unsafe void	SetSectionType (string strSectionType)
	This method sets the section type outside the block. More...

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

unsafe void	SetSpreadsheetDataStatus (string[] paramNames, int[] paramStatus)
	Sets the parameter status such as locked, system key, user key, hidden, editable, non-standard value etc. More...

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

unsafe void	UpdateSpreadsheetData (string[] paramNames, string[] paramValues)
	This method takes parameter name and parameter value pairs as input and updates the related geometries by updating the expressions, i. More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

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

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe int	SectionType `[get, set]`
	Returns or sets the section type More...

unsafe string	SteelFeatureType `[get, set]`
	Returns or sets the steel feature type (eg: Profile, Edge Reinforcement, etc) More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.CacheSpreadsheetData ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.DeleteImportedSketch ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.EditParameter	(	string	parameterName,
		string	parameterValue
	)

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.EditPrimaryParameter	(	string	parameterName,
		string	parameterValue
	)

inline

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

unsafe string [] NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.GetAvailableSectionTypes ( )

inline

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.

Created in NX8.0.0

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

Returns: Array of available section types

unsafe NXOpen.Features.Feature [] NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.GetImportedSketches ( )

inline

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

Created in NX8.0.0

License requirements: None.

Returns

unsafe NXOpen.Tooling.SpreadsheetDataParameter [] NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.GetParameterValues ( )

inline

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

Created in NX8.0.0

License requirements: None.

Returns: Array of structures with the parameter data.

unsafe NXOpen.Tooling.SpreadsheetData NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.GetSpreadsheetData ( )

inline

It retrieves the KRUSpreadsheetData object to the builder.

In most cases, this method is used internally.

Created in NX8.0.0

License requirements: None.

Returns

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.ImportSketch ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.ResetBuilderData ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.RestoreSpreadsheetData ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetContextEntity ( NXOpen.TaggedObject contextEntity )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetPossibleContextAttribute	(	int	possibleContextAttributeIndex,
		string	possibleContextAttribute
	)

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetPossibleContextAttributeCount ( int possibleContextAttributeCount )

inline

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)

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetRuleInputs	(	string[]	inputNames,
		string[]	inputValues
	)

inline

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
inputValues

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetsDefaultTypesFromContext ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetSectionSubType1 ( string strSectionType )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetSectionSubType2 ( string strSectionType )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetSectionType ( string strSectionType )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetSpreadsheetData ( NXOpen.Tooling.SpreadsheetData pKRUData )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SetSpreadsheetDataStatus	(	string[]	paramNames,
		int[]	paramStatus
	)

inline

Sets the parameter status such as locked, system key, user key, hidden, editable, non-standard value etc.

Created in NX12.0.1

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

Parameters

paramNames
paramStatus

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.UpdateParametersUsingRules ( )

inline

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

unsafe void NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.UpdateSpreadsheetData	(	string[]	paramNames,
		string[]	paramValues
	)

inline

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
paramValues

Property Documentation

unsafe int NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SectionType

getset

Returns or sets the section type

Created in NX8.0.0

Deprecated in NX8.5.0. Removed with no replacement

License requirements to get this property: None.

License requirements to set this property: nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe string NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.SteelFeatureType

getset

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

Created in NX8.0.0

License requirements to get this property: nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

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

Features_ShipDesign_SteelFeatureSpreadsheetBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation