FloatParameterDefinition

class ansys.hps.client.jms.FloatParameterDefinition(id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, name=<marshmallow.missing>, quantity_name=<marshmallow.missing>, units=<marshmallow.missing>, display_text=<marshmallow.missing>, mode=<marshmallow.missing>, type=<marshmallow.missing>, default=<marshmallow.missing>, lower_limit=<marshmallow.missing>, upper_limit=<marshmallow.missing>, step=<marshmallow.missing>, cyclic=<marshmallow.missing>, value_list=<marshmallow.missing>, **kwargs)

Provides the float parameter definition resource.

Parameters:

idstr, optional

Unique ID to access the resource, generated internally by the server on creation.

creation_timedatetime, optional

Date and time that the resource was created.

modification_timedatetime, optional

Date and time that the resource was last modified.

created_bystr, optional

ID of the user who created the object.

modified_bystr, optional

ID of the user who last modified the object.

namestr, optional

Name (ID) of the parameter.

quantity_namestr, optional

Name of the quantity that the parameter represents. For example, Length.

unitsstr, optional

Units for the parameter.

display_textstr, optional

Text to display as the parameter name.

modestr

Indicates whether it’s an input or output parameter. The mode is filled server-side.

typestr

defaultfloat, optional

Default parameter value.

lower_limitfloat, optional

Lower bound for the parameter value.

upper_limitfloat, optional

Upper bound for the parameter value.

stepfloat, optional

If provided, allowable values are given by: AllowableValue = lower_limit + n * step, where n is an integer and AllowableValue <= upper_limit.

cyclicbool, optional

Whether the parameter is cyclic.

value_listlist, optional

List of allowed values. This parameter provides an alternative to specifying upper and lower limits.

Methods

FloatParameterDefinition.declared_fields()	Provides a helper function for retrieving fields to define as class members for an object.
FloatParameterDefinition.get(key[, default])