Represents parameter in the spreadsheet. More...

Inheritance diagram for NXOpen::Tooling::SpreadsheetDataParameter:

Public Types
enum	Status { StatusLock = 1, StatusSystemKey, StatusUserKey = 4, StatusHideStatus = 8, StatusScaleItem = 16, StatusReadOnly = 32, StatusModified = 64, StatusForceColor = 128, StatusHiddenValue = 256, StatusOptionValue = 512, StatusNonStandardValue = 1024, StatusShipRule = 2048 }
	Represents the different spreadsheet parameter status. More...

Public Member Functions
NXString	DescriptiveName ()
	Returns the descriptive name of the parameter Created in NX8.0.0. More...

void	GetValueList (std::vector< NXString > &paraValues)
	Get the list of values by giving a parameter name in spreadsheet Created in NX10.0.0. More...

bool	HasStatus (NXOpen::Tooling::SpreadsheetDataParameter::Status parameterStatus)
	Check if the parameter has the given status. More...

NXString	ParameterName ()
	Returns the name of the parameter Created in NX8.0.0. More...

int	ParameterStatus ()
	Returns the status of the parameter Created in NX10.0.0. More...

NXString	ParameterValue ()
	Returns the value of the parameter Created in NX8.0.0. More...

void	SetDescriptiveName (const NXString &descriptiveName)
	Sets the descriptive name of the parameter Created in NX8.0.0. More...

void	SetDescriptiveName (const char *descriptiveName)
	Sets the descriptive name of the parameter Created in NX8.0.0. More...

void	SetParameterName (const NXString &parameterName)
	Sets the name of the parameter Created in NX8.0.0. More...

void	SetParameterName (const char *parameterName)
	Sets the name of the parameter Created in NX8.0.0. More...

void	SetParameterStatus (int parameterStatus)
	Sets the status of the parameter Created in NX10.0.0. More...

void	SetParameterValue (const NXString &parameterValue)
	Sets the value of the parameter Created in NX8.0.0. More...

void	SetParameterValue (const char *parameterValue)
	Sets the value of the parameter Created in NX8.0.0. More...

virtual	~SpreadsheetDataParameter ()
	Dispose the spreadsheet object Created in NX8.0.0. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents parameter in the spreadsheet.

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Tooling::SpreadsheetDataParameter::Status

Represents the different spreadsheet parameter status.

Enumerator
StatusLock	User can't change the value in UI.
StatusSystemKey	This is system key parameter.
StatusUserKey	Key parameter analyzed from spreadsheet search.
StatusHideStatus	Not shown in UI.
StatusScaleItem	This is a scale item.
StatusReadOnly	This parameter is read only.
StatusModified	The parameter value is changed.
StatusForceColor	If the parameter uses user value, normally it shows in UI in a different color. If this status is set, the parameter value will be shown in the same color.
StatusHiddenValue	The parameter has value, but it should be hidden to user.
StatusOptionValue	The parameter has multiple value, but not treated as key parameter.
StatusNonStandardValue	The current value of this parameter is user's input, not from spreadsheet.
StatusShipRule	This is used for ship design to trigger design. Syntax is ^$parameterName. 0 not to trigger rule, 1 to trigger rule.

Constructor & Destructor Documentation

virtual NXOpen::Tooling::SpreadsheetDataParameter::~SpreadsheetDataParameter ( )

virtual

Dispose the spreadsheet object
Created in NX8.0.0.

License requirements : None

Member Function Documentation

NXString NXOpen::Tooling::SpreadsheetDataParameter::DescriptiveName ( )

Returns the descriptive name of the parameter
Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::SpreadsheetDataParameter::GetValueList ( std::vector< NXString > & paraValues )

Get the list of values by giving a parameter name in spreadsheet
Created in NX10.0.0.

License requirements : None

Parameters

paraValues The list of values

bool NXOpen::Tooling::SpreadsheetDataParameter::HasStatus ( NXOpen::Tooling::SpreadsheetDataParameter::Status parameterStatus )

Check if the parameter has the given status.

Returns: true or not
Created in NX10.0.0.

License requirements : None

Parameters

parameterStatus status of the parameter

NXString NXOpen::Tooling::SpreadsheetDataParameter::ParameterName ( )

Returns the name of the parameter
Created in NX8.0.0.

License requirements : None

int NXOpen::Tooling::SpreadsheetDataParameter::ParameterStatus ( )

Returns the status of the parameter
Created in NX10.0.0.

License requirements : None

NXString NXOpen::Tooling::SpreadsheetDataParameter::ParameterValue ( )

Returns the value of the parameter
Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::SpreadsheetDataParameter::SetDescriptiveName ( const NXString & descriptiveName )

Sets the descriptive name of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

descriptiveName descriptive name of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetDescriptiveName ( const char * descriptiveName )

Sets the descriptive name of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

descriptiveName descriptive name of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetParameterName ( const NXString & parameterName )

Sets the name of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

parameterName name of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetParameterName ( const char * parameterName )

Sets the name of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

parameterName name of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetParameterStatus ( int parameterStatus )

Sets the status of the parameter
Created in NX10.0.0.

License requirements : None

Parameters

parameterStatus status of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetParameterValue ( const NXString & parameterValue )

Sets the value of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

parameterValue value of the parameter

void NXOpen::Tooling::SpreadsheetDataParameter::SetParameterValue ( const char * parameterValue )

Sets the value of the parameter
Created in NX8.0.0.

License requirements : None

Parameters

parameterValue value of the parameter

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

Tooling_SpreadsheetDataParameter.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation