UdeParameter Class¶
-
class
NXOpen.CAM.
UdeParameter
¶ Bases:
NXOpen.TaggedObject
Represents a User Defined Event Parameter
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
BooleanValue | Returns or sets the boolean value of the parameter |
DoubleValue | Returns or sets the double value of the parameter |
IntegerValue | Returns or sets the integer value of the parameter |
NameOfParameter | Returns the name of the parameter |
OptionText | Returns or sets the option utf8 value of the parameter |
OptionValue | Returns or sets the option value of the parameter |
ParameterActive | Returns or sets the check to see if paramter is active |
ParameterOptional | Returns the check to see if the parameter is optional |
Point | Returns or sets the point of the parameter |
StringText | Returns or sets the string utf8 value of the parameter |
StringValue | Returns or sets the string value of the parameter |
Tag | Returns the Tag for this object. |
TypeOfParameter | Returns the type of the parameter |
Vector | Returns or sets the vector of the parameter |
Methods¶
Enumerations¶
UdeParameterParameterTypes Enumeration | the parameter Type |
Property Detail¶
BooleanValue¶
-
UdeParameter.
BooleanValue
¶ Returns or sets the boolean value of the parameter
-------------------------------------
Getter Method
Signature
BooleanValue()
Returns: boolean value of parameter Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BooleanValue(booleanValue)
Parameters: booleanValue (bool) – boolean value of the parameter New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
DoubleValue¶
-
UdeParameter.
DoubleValue
¶ Returns or sets the double value of the parameter
-------------------------------------
Getter Method
Signature
DoubleValue()
Returns: double value of parameter Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoubleValue(doubleValue)
Parameters: doubleValue (float) – double value of the parameter New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
IntegerValue¶
-
UdeParameter.
IntegerValue
¶ Returns or sets the integer value of the parameter
-------------------------------------
Getter Method
Signature
IntegerValue()
Returns: integer value of parameter Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntegerValue(integerValue)
Parameters: integerValue (int) – integer value of the parameter New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
NameOfParameter¶
-
UdeParameter.
NameOfParameter
¶ Returns the name of the parameter
-------------------------------------
Getter Method
Signature
NameOfParameter()
Returns: name of the parameter Return type: str New in version NX7.5.0.
License requirements: None.
OptionText¶
-
UdeParameter.
OptionText
¶ Returns or sets the option utf8 value of the parameter
-------------------------------------
Getter Method
Signature
OptionText()
Returns: option value of the parameter Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OptionText(optionValue)
Parameters: optionValue (str) – option value of the parameter New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
OptionValue¶
-
UdeParameter.
OptionValue
¶ Returns or sets the option value of the parameter
-------------------------------------
Getter Method
Signature
OptionValue()
Returns: option value of the parameter Return type: str New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
CAM.UdeParameter.OptionText`()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
OptionValue(optionValue)
Parameters: optionValue (str) – option value of the parameter New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
CAM.UdeParameter.OptionText`()
instead.License requirements: cam_base (“CAM BASE”)
ParameterActive¶
-
UdeParameter.
ParameterActive
¶ Returns or sets the check to see if paramter is active
-------------------------------------
Getter Method
Signature
ParameterActive()
Returns: if parameter is active Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParameterActive(parameterActive)
Parameters: parameterActive (bool) – parameter is active New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
ParameterOptional¶
-
UdeParameter.
ParameterOptional
¶ Returns the check to see if the parameter is optional
-------------------------------------
Getter Method
Signature
ParameterOptional()
Returns: if parameter is optional Return type: bool New in version NX7.5.0.
License requirements: None.
Point¶
-
UdeParameter.
Point
¶ Returns or sets the point of the parameter
-------------------------------------
Getter Method
Signature
Point()
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
Point(tagValue)
Parameters: tagValue ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
StringText¶
-
UdeParameter.
StringText
¶ Returns or sets the string utf8 value of the parameter
-------------------------------------
Getter Method
Signature
StringText()
Returns: string value of parameter Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringText(stringValue)
Parameters: stringValue (str) – string value of the parameter New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
StringValue¶
-
UdeParameter.
StringValue
¶ Returns or sets the string value of the parameter
-------------------------------------
Getter Method
Signature
StringValue()
Returns: string value of parameter Return type: str New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
CAM.UdeParameter.StringText`()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
StringValue(stringValue)
Parameters: stringValue (str) – string value of the parameter New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
CAM.UdeParameter.StringText`()
instead.License requirements: cam_base (“CAM BASE”)
TypeOfParameter¶
-
UdeParameter.
TypeOfParameter
¶ Returns the type of the parameter
-------------------------------------
Getter Method
Signature
TypeOfParameter()
Returns: type of the parameter Return type: NXOpen.CAM.UdeParameterParameterTypes
New in version NX10.0.1.
License requirements: None.
Vector¶
-
UdeParameter.
Vector
¶ Returns or sets the vector of the parameter
-------------------------------------
Getter Method
Signature
Vector()
Returns: Return type: NXOpen.NXObject
New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Setter Method
Signature
Vector(tagValue)
Parameters: tagValue ( NXOpen.NXObject
) –New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)