FieldDefinition

class compolyx.FieldDefinition(graph, obj, parent=None)

Class to represent field definition.

Attributes

Name	Description
FieldDefinition.active	Field Definition is active
FieldDefinition.enabled	Whether this object is currently enabled or not
FieldDefinition.field_variable_name	The name of the field variable defined
FieldDefinition.full_mapping	Whether the field is interpolated to the shell reference surface or to the actual ply-position by taking into account the shell offset; in solid models the interpolation takes always place at the actual ply position
FieldDefinition.id	ID of object
FieldDefinition.is_dict_item	Specifies wether the object is an item of a dict
FieldDefinition.is_list_item	Specifies wether the object is an item of a list
FieldDefinition.link_path	Root path of the current node in the tree for links to this object
FieldDefinition.locked	Returns the locked status of the Field Definition
FieldDefinition.name	Name of object
FieldDefinition.parent	Parent object in tree
FieldDefinition.root_path	Root path of the current node in the tree
FieldDefinition.scalar_field	Look-up table column used with this field definition
FieldDefinition.scope_entities	The entities defining the scope of the field definition
FieldDefinition.status	Status of the object
FieldDefinition.status_changed	Boolean flag which is set to true in C++ when up-to-date status of object changes
FieldDefinition.uid	UID of object
FieldDefinition.vertex	Throws an error if the object has been removed from the graph

Methods

Name	Description
FieldDefinition.clear_field_definition()
FieldDefinition.clear_scope_entities()
FieldDefinition.find_parent(type)	Steps up the tree and returns the first parent with given type
FieldDefinition.get_short_description()
FieldDefinition.obj_exists()	Checks if __obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph
FieldDefinition.serialize()	Serialize to Python string
FieldDefinition.serialize_name_and_id()	Helper function to serialize name and ID
FieldDefinition.update()
FieldDefinition.visit(visitor)	Walk through the tree and let the visitor perform action on every descendant node