NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
NXOpen::Tooling::SpreadsheetDataParameter类 参考

电子表格数据参数 更多...

#include <Tooling_SpreadsheetDataParameter.hxx>

类 NXOpen::Tooling::SpreadsheetDataParameter 继承关系图:
NXOpen::TransientObject

Public 类型

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
}

Public 成员函数

NXString DescriptiveName ()
void GetValueList (std::vector< NXString > &paraValues)
bool HasStatus (NXOpen::Tooling::SpreadsheetDataParameter::Status parameterStatus)
NXString ParameterName ()
int ParameterStatus ()
NXString ParameterValue ()
void SetDescriptiveName (const char *descriptiveName)
void SetDescriptiveName (const NXString &descriptiveName)
void SetParameterName (const char *parameterName)
void SetParameterName (const NXString &parameterName)
void SetParameterStatus (int parameterStatus)
void SetParameterValue (const char *parameterValue)
void SetParameterValue (const NXString &parameterValue)
virtual ~SpreadsheetDataParameter ()
Public 成员函数 继承自 NXOpen::TransientObject
void * GetHandle ()

详细描述

电子表格数据参数

   Represents parameter in the spreadsheet.


Created in NX8.0.0.

成员枚举类型说明

◆ Status

Represents the different spreadsheet parameter status

枚举值
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.

构造及析构函数说明

◆ ~SpreadsheetDataParameter()

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

Dispose the spreadsheet object
Created in NX8.0.0.

License requirements : None

成员函数说明

◆ DescriptiveName()

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

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

License requirements : None

◆ GetValueList()

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

参数
paraValuesThe list of values

◆ HasStatus()

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

Check if the parameter has the given status

返回
true or not
Created in NX10.0.0.

License requirements : None
参数
parameterStatusstatus of the parameter

◆ ParameterName()

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

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

License requirements : None

◆ ParameterStatus()

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

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

License requirements : None

◆ ParameterValue()

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

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

License requirements : None

◆ SetDescriptiveName() [1/2]

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

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

License requirements : None

参数
descriptiveNamedescriptive name of the parameter

◆ SetDescriptiveName() [2/2]

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

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

License requirements : None

参数
descriptiveNamedescriptive name of the parameter

◆ SetParameterName() [1/2]

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

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

License requirements : None

参数
parameterNamename of the parameter

◆ SetParameterName() [2/2]

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

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

License requirements : None

参数
parameterNamename of the parameter

◆ SetParameterStatus()

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

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

License requirements : None

参数
parameterStatusstatus of the parameter

◆ SetParameterValue() [1/2]

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

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

License requirements : None

参数
parameterValuevalue of the parameter

◆ SetParameterValue() [2/2]

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

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

License requirements : None

参数
parameterValuevalue of the parameter