PublishedParameter

class compolyx.PublishedParameter(name, parent, source_object=None, source_property='', user_script='', category='input', acp_type=None, description='', lower_limit=None, upper_limit=None, cyclic=False, float_list=[], string_list=[], unbound_value=None)

Class to represent parameters which are linked to the Ansys Workbench application.

Attributes

Name	Description
PublishedParameter.acp_type	ACP parameter type
PublishedParameter.ansys_type	ANSYS parameter type where ACP parameter is mapped to
PublishedParameter.category	Should be one of: input, unbound_input, output or expression_output
PublishedParameter.cyclic	Whether a float value is cyclic or not
PublishedParameter.description	A human-readable description of the linked parameter
PublishedParameter.enabled	Whether this object is currently enabled or not
PublishedParameter.float_list	A list of possible values for a float
PublishedParameter.is_dict_item	Specifies whether the object is an item of a dict
PublishedParameter.is_list_item	Specifies whether the object is an item of a list
PublishedParameter.link_path	Root path of the current node in the tree for links to this object
PublishedParameter.lower_limit	The lower limit for numeric values
PublishedParameter.name	Name of object
PublishedParameter.parent	Parent object in tree
PublishedParameter.root_path	Root path of the current node in the tree
PublishedParameter.source_object
PublishedParameter.source_property
PublishedParameter.string_list	A list of possible values
PublishedParameter.unit	The unit associated with the actual parameter value
PublishedParameter.upper_limit	The upper limit for numeric values
PublishedParameter.user_script
PublishedParameter.value	The current parameter value
PublishedParameter.wb_value	The parameter value as it is represented in the ANSYS Workbench application

Methods

Name	Description
PublishedParameter.find_parent(type)	Function steps up the tree and returns the first parent with given type
PublishedParameter.get_source_str()	Returns the active source string
PublishedParameter.serialize()	Serialize to Python string
PublishedParameter.update()
PublishedParameter.user_script_default()
PublishedParameter.visit(visitor)	Walk through the tree and let the visitor perform action on every descendant node