oaParam

模块: oapy._oa._base 导入: from oapy._oa import _base

概览

oaParam 在 oapy 中可用，可通过 _base 模块访问。

本页汇总 oaParam 当前在 oapy 中可用的 Python 接口。

详细说明

The oaParam utility class represents a parameter used to specify a desired customization of a pcell。 Pcells are parameterized designs that can be modified for each instance by specifying appropriate parameter values。 A parameter is essentially a name/type/value triplet。 Each oaParam can be of any of the supported types。 The type of its value must be consistent with the type of the oaParam。 It is permissible to change the param's type from one type to another by calling a set() function on a param object。 Note: It is illegal to perform a get() call on a parameter with the wrong value type -- for example, if you call getStringVal() on a parameter of type oacIntParamType。 If you perform an illegal get() call with the debug version of OpenAccess, it will throw an oacParamTypeDoesNotMatchWithGetFunction exception。 If you perform an illegal get() call with the optimized version, function behavior is undefined, and your program may crash。 While oaParam objects may be constructed by themselves, when they are used in the API for pcells they are always elements of an oaParamArray 。 Hence that is the most common way for applications to use them。

构造函数

_base.oaParam()

obj = _base.oaParam()

_base.oaParam(param)

obj = _base.oaParam(param)

_base.oaParam(nameIn, value)

obj = _base.oaParam(nameIn, value)

_base.oaParam(nameIn, value)

obj = _base.oaParam(nameIn, value)

_base.oaParam(nameIn, value)

obj = _base.oaParam(nameIn, value)

_base.oaParam(nameIn, value)

obj = _base.oaParam(nameIn, value)

_base.oaParam(nameIn, appTypeIn, numBytesIn, byteDataIn)

obj = _base.oaParam(nameIn, appTypeIn, numBytesIn, byteDataIn)

方法总览

状态	Python 调用
✅	obj.getName(name)
✅	obj.getType()
✅	obj.getIntVal()
✅	obj.getFloatVal()
✅	obj.getStringVal()
✅	obj.getDoubleVal()
✅	obj.getBooleanVal()
✅	obj.getTimeVal()
✅	obj.getStringVal(value)
✅	obj.getAppVal(byteData)
✅	obj.getNumBytes()
✅	obj.getAppType(value)
✅	obj.setAppType(value)
✅	obj.setAppVal(numBytes, byteData)
✅	obj.setName(nameIn)
✅	obj.setIntVal(value)
✅	obj.setFloatVal(value)
✅	obj.setStringVal(value)
✅	obj.setDoubleVal(value)
✅	obj.setBooleanVal(value)
✅	obj.setTimeVal(value)
✅	obj.operator=(param)
✅	obj.operator==(p)
✅	obj.operator!=(p)

方法说明

obj.getName(name)

绑定状态: 已绑定

Python 调用: obj.getName(name)

This function retrieves the name of this oaParam object in the 'nameIn' parameter。

参数

• nameIn: A reference to an oaString object to be populated with the name of this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getName(name)

obj.getType()

绑定状态: 已绑定

Python 调用: obj.getType()

This function returns the type of this oaParam object which specifies the form of its value。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getType()

obj.getIntVal()

绑定状态: 已绑定

Python 调用: obj.getIntVal()

This function returns the value of this integer-type oaParam object。 If the param isn't storing an integer value then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getIntVal()

obj.getFloatVal()

绑定状态: 已绑定

Python 调用: obj.getFloatVal()

This function returns the value of this float-type oaParam object。 If the param isn't storing a float value then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getFloatVal()

obj.getStringVal()

绑定状态: 已绑定

Python 调用: obj.getStringVal()

This function retrieves the value of this string-type oaParam object in the 'value' parameter。 If it isn't storing a string value then the result is indeterminate。

参数

• value: A reference to an oaString object to be populated with the string value that this oaParam object represents。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getStringVal()

obj.getDoubleVal()

绑定状态: 已绑定

Python 调用: obj.getDoubleVal()

This function returns the value of this double-type oaParam object。 If the param isn't storing a double value then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getDoubleVal()

obj.getBooleanVal()

绑定状态: 已绑定

Python 调用: obj.getBooleanVal()

This function returns the value of this boolean-type oaParam object。 If the param isn't storing a boolean value, then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getBooleanVal()

obj.getTimeVal()

绑定状态: 已绑定

Python 调用: obj.getTimeVal()

This function returns the value of this time-type oaParam object。 If it isn't storing a time value then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getTimeVal()

obj.getStringVal(value)

绑定状态: 已绑定

Python 调用: obj.getStringVal(value)

This function returns a pointer to the string value of this string-type oaParam object。 If it isn't storing a string value then the result is indeterminate。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getStringVal(value)

obj.getAppVal(byteData)

绑定状态: 已绑定

Python 调用: obj.getAppVal(byteData)

This function gets the value of this application-type oaParam object。 It assumes that the application had earlier assigned such a value to the oaParam object。 A fatal application error can occur if an attempt is made to retrieve a value that was not stored earlier。

参数

• value: A pointer to an array of bytes to be populated。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getAppVal(byteData)

obj.getNumBytes()

绑定状态: 已绑定

Python 调用: obj.getNumBytes()

This function returns the number of bytes of this application-type oaParam object。 If it isn't storing an application param then it returns 0。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getNumBytes()

obj.getAppType(value)

绑定状态: 已绑定

Python 调用: obj.getAppType(value)

This function retrieves the oaAppType string of this application-type oaParam object using the 'appTypeIn' parameter。

参数

• appTypeIn: A reference to an oaString to be populated with the appType information。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.getAppType(value)

obj.setAppType(value)

绑定状态: 已绑定

Python 调用: obj.setAppType(value)

This function sets the appType string for this application-type oaParam object。 The oaAppType string distinguishes this application-type parameter from other application-type parameters that can have the same name。 If this param isn't an application param then this call has no effect。 So if you are using an oaParam that previously held a different type and you are setting it to be an application-type param, you must call setAppVal before calling setAppType。

参数

• value: The appType string to be associated with this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setAppType(value)

obj.setAppVal(numBytes, byteData)

绑定状态: 已绑定

Python 调用: obj.setAppVal(numBytes, byteData)

This function sets the value of this application-type oaParam object to be the raw array of bytes 'byteDataIn' with a length of 'numBytesIn'。

参数

• numBytesIn: The number of bytes to be assigned to this oaParam object。
• byteDataIn: A pointer to the location where the byte array starts。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setAppVal(numBytes, byteData)

obj.setName(nameIn)

绑定状态: 已绑定

Python 调用: obj.setName(nameIn)

This function sets the name of this oaParam object to that specified by the string parameter 'nameIn'。

参数

• nameIn: A string representing the name to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setName(nameIn)

obj.setIntVal(value)

绑定状态: 已绑定

Python 调用: obj.setIntVal(value)

This function sets this oaParam to be an integer-type param with the specified 'value'。

参数

• value: An integer value to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setIntVal(value)

obj.setFloatVal(value)

绑定状态: 已绑定

Python 调用: obj.setFloatVal(value)

This function sets this oaParam to be a float-type param with the specified 'value'。

参数

• value: A float value to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setFloatVal(value)

obj.setStringVal(value)

绑定状态: 已绑定

Python 调用: obj.setStringVal(value)

This function sets this oaParam to be a string-type param with the specified 'value'。

参数

• value: A string to be assigned to this oaParam object as its new value。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setStringVal(value)

obj.setDoubleVal(value)

绑定状态: 已绑定

Python 调用: obj.setDoubleVal(value)

This function sets this oaParam to be a double-type param with the specified 'value'。

参数

• value: A double value to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setDoubleVal(value)

obj.setBooleanVal(value)

绑定状态: 已绑定

Python 调用: obj.setBooleanVal(value)

This function sets this oaParam to be a boolean-type param with the specified 'value'。

参数

• value: The boolean value to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setBooleanVal(value)

obj.setTimeVal(value)

绑定状态: 已绑定

Python 调用: obj.setTimeVal(value)

This function sets this oaParam to be a time-type param with the specified 'value'。

参数

• value: An oaTime value to be assigned to this oaParam object。

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.setTimeVal(value)

obj.operator=(param)

绑定状态: 已绑定

Python 调用: obj.operator=(param)

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.operator=(param)

obj.operator==(p)

绑定状态: 已绑定

Python 调用: obj.operator==(p)

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.operator==(p)

obj.operator!=(p)

绑定状态: 已绑定

Python 调用: obj.operator!=(p)

Python 示例

from oapy._oa import _base

# assume obj is a oaParam
obj.operator!=(p)