Named (hwx.inspire.core)¶
Base class for all data model objects except Features.
Attributes¶
Properties¶
Public Methods¶
classmethod getClass (cls, className)
destroy (self)
getAllChildren (self, type=None, **kwds)
getChildren (self, type=None, recursive=False, sorted=False, **kwds)
getDependents (self, recursive=False, **kwds)
getReferences (self, recursive=False, **kwds)
isa (self, type=None, filter=None, name=None, wildcard=None, **kwds)
modelPositions (self)
Attribute Details¶
active : Bool¶
Returns or sets the object activeness.
Setting this on or off sets all children. Setting to True sets all the parents active too.
name : Attribute¶
Returns or sets the name of the object.
It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.
While these characters are allowed, they could create difficulties when you export the model to other applications.
visible : Bool¶
Determines whether the object is visible in the graphics window.
Setting this on or off sets all children. Setting to True sets all the parents visible too.
Property Details¶
- property history¶
History: Get the history object used to manage undo/redo.
- property model¶
Model: Get the model this object belongs to.
- property parent¶
Assembly: Returns the parent of this entity.
- property units¶
UnitManager: Get the model’s unit manager
Method Details¶
- classmethod getClass(cls, className)¶
Returns the class of the object.
It can be simple or qualified (with namespace). If the name is simple, we prepend the cls.namespace.
- param className
The class name.
- type className
Union[Part, Occurrence, Named..]
- returns
The class for the specified className.
- rtype
Union[Part, Occurrence, Named..]
- destroy(self)¶
Delete the object removing it from the model.
The object may come back due to an undo/redo.
- getAllChildren(self, type=None, **kwds)¶
Returns a list of all children that matches the specified type.
- param type
Filter to use to get the children based on object type.
- type type
list[Named]
- param **kwds
Additional keyword arguments to match other attributes of the object.
- returns
The list of children that satisfy the supplied filters.
- rtype
list[Union[Part, Motor, BoundaryCondition, …]]
- getChild(self, name=None, recursive=False, **kwds)¶
Returns the child of the object which matches the specified unique name.
- param name
The name of the child object.
- type name
str
- param recursive
Search all descendents.
- type recursive
bool
- param **kwds
Additional keyword arguments to match attributes of the object.
- returns
The child object which satisfies the specified filters.
- rtype
Named
- getChildren(self, type=None, recursive=False, sorted=False, **kwds)¶
Returns a list of children that is of the specified type.
- param type
Filter objects by class.
- type type
Type[Named]
- param recursive
True to get all descendent Parts and Assemblies.
- type recursive
bool
- param sorted
Sort the children base on id.
- type sorted
bool
- returns
list[Named]
- getDependents(self, recursive=False, **kwds)¶
Get objects that reference this object through a Reference attribute.
- param recursive
- type recursive
bool
- param **kwds
Filter objects using isa.
- returns
set[Named]
- getReferences(self, recursive=False, **kwds)¶
Get objects this object references through a Reference attribute.
- param recursive
- type recursive
bool
- param **kwds
Filter objects using isa.
- returns
set[Named]
- isa(self, type=None, filter=None, name=None, wildcard=None, **kwds)¶
Determines if the object matches the specified settings or not.
- param type
The type of the object.
- type type
Union[Part, Assembly, Contact..]
- param filter
Return value of specified callback method.
- type filter
method
- param name
Name that matches exactly with object name.
- type name
str
- param wildcard
A pattern to match exactly with the object name.
- type wildcard
str
- param **kwds
Additional keyword arguments to match other attributes.
- returns
True, if a match is found, otherwise False.
- rtype
bool
- modelPositions(self)¶
Forces all objects to return the original model positions instead of the current analysis positions.
Useful when defining draw methods on GeneralObjects where behaviour is different while animating.