BoolParameterDefinition

class ansys.hps.client.jms.BoolParameterDefinition(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>, **kwargs)

Provides the bool 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, optional

Indicates whether it’s an input or output parameter. If not provided, the server will default the mode to input.

typestr

defaultbool, optional

Default parameter value.

Initialize the object.

Methods

BoolParameterDefinition.declared_fields()	Provide a helper function for retrieving fields.
BoolParameterDefinition.get(key[, default])	Get an item from the object, returning a default value if the key is not found.