System (hwx.inspire)#

class System(**kwds)#

Bases: BaseSystem

System defines an orthonormal, right-handed coordinate system.

A part can be associated to the system.

Attribute Table#
Name	Type
`solverVariables`	`tuple`
`location`	`property`
`moveWithPart`	`Bool`
`origin`	`Location`
`part`	`Reference`
`position`	`Position`
`type`	`Enum`
`active`	`Bool`
`fullName`	`property`
`history`	`History`
`model`	`Model`
`name`	`String`
`namespace`	`str`
`parent`	`property`
`path`	`property`
`units`	`UnitsManager`
`visible`	`Bool`

Method Table#
Name	Description
`destroy` (self)	Delete the object removing it from the model.
`getAllChildren` (self, type=None, **kwds)	Returns a list of all children that matches the specified type.
`getChild` (self, name=None, recursive=False, **kwds)	Returns the child of the object which matches the specified unique name.
`getChildren` (self, type=None, recursive=False, sorted=False, **kwds)	Returns a list of children that is of the specified type.
`getClass` (className)	Returns the class of the object.
`getDependents` (self, recursive=False, **kwds)	Get objects that reference this object through a Reference attribute.
`getFullName` (self, other)
`getReferences` (self, recursive=False, **kwds)	Get objects this object references through a Reference attribute.
`isa` (self, type=None, filter=None, name=None, wildcard=None, **kwds)	Determines if the object matches the specified settings or not.
`modelPositions` (self)	Forces all objects to return the original model positions instead of the

Example

from hwx import inspire

model = inspire.newModel()
block = model.createSolidBlock(location=(0, 0, 0))

# create a system
my_system = inspire.System()

# system has no part
print("Created one system and one block not associated")
print("My system part: " + str(my_system.part))
# block is at position (0,0,0)
print("Block position: " + str(block.location))

# attach system to block
my_system.part = block
print("")
print("System and block associated")
print("My system part: " + str(my_system.part))

# Do not move system with block
my_system.moveWithPart = False
print("")
print("Move system with part: " + str(my_system.moveWithPart))
print("Block position: " + str(block.location))
print("My system location: " + str(my_system.location))
print("Moving block...")
block.location = (1, 1, 1)
print("Block position: " + str(block.location))
print("My system location: " + str(my_system.location))

# Move system with block
my_system.moveWithPart = True
print("")
print("Move system with part: " + str(my_system.moveWithPart))
print("Block position: " + str(block.location))
print("My system location: " + str(my_system.location))
print("Moving block...")
block.location = (3, 3, 3)
print("Block position: " + str(block.location))
print("My system location: " + str(my_system.location))

inspire.fitView()

class SystemType(value)#

Bases: Enum

An enumeration.

Attribute Table#
Name	Type
`Axis`	`SystemType`
`Plane`	`SystemType`
`Point`	`SystemType`
`System`	`SystemType`

property active#

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

destroy()#

Delete the object removing it from the model.

The object may come back due to an undo/redo.

getAllChildren(type=None, **kwds)#

Returns a list of all children that matches the specified type.

Parameters:

type (list[Named]) – Filter to use to get the children based on object type.
**kwds – Additional keyword arguments to match other attributes of the object.

Returns:

The list of children that satisfy the supplied filters.

Return type:

list[Union[Part, Motor, BoundaryCondition, …]]

getAttribute(name)#

Returns the Attribute off the class, not the value.

Parameters:: name (str) – Attribute name to find its class.

getChild(name=None, recursive=False, **kwds)#

Returns the child of the object which matches the specified unique name.

Parameters:

name (str) – The name of the child object.
recursive (bool) – Search all descendents.
**kwds – Additional keyword arguments to match attributes of the object.

Returns:

The child object which satisfies the specified filters.

Return type:

Named

getChildren(type=None, recursive=False, sorted=False, **kwds)#

Returns a list of children that is of the specified type.

Parameters:

type (Type[Named]) – Filter objects by class.
recursive (bool) – True to get all descendent Parts and Assemblies.
sorted (bool) – Sort the children base on id.

Returns:

list[Named]

getDependents(recursive=False, **kwds)#

Get objects that reference this object through a Reference attribute.

Parameters:

recursive (bool) –
**kwds – Filter objects using isa.

Returns:

set[Named]

getGuiValue(attr, **kwds)#

Get value formatted to be shown in the gui

Parameters:: attr (str) – Attribute name to gets its gui value.
Returns:: Returns a string of the value with its gui units, like “5 mm/s”.
Return type:: str

getReferences(recursive=False, **kwds)#

Get objects this object references through a Reference attribute.

Parameters:

recursive (bool) –
**kwds – Filter objects using isa.

Returns:

set[Named]

getValue(attr)#

Return the attribute value for passed attribute name.

Parameters:: attr (String) – Attribute name to gets its value.
Returns:: Returns the attribute value
Return type:: str

isa(type=None, filter=None, name=None, wildcard=None, **kwds)#

Determines if the object matches the specified settings or not.

Parameters:

type (Union[Part, Assembly, Contact..]) – The type of the object.
filter (method) – Return value of specified callback method.
name (str) – Name that matches exactly with object name.
wildcard (str) – A pattern to match exactly with the object name.
**kwds – Additional keyword arguments to match other attributes.

Returns:

True, if a match is found, otherwise False.

Return type:

bool

property location#: Origin of this system position as a Point.

modelPositions()#

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.

property moveWithPart#: Whether the system is moving with the associated part or not.

property name#

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.

property origin#: The origin of this system in local coordinate system.

property parent#

Returns the parent of this entity.

Type:: Assembly

property part#: The part associated with this system.

property position#: The global transform as a Matrix44.

setValue(attr, value)#: Alias for setattr (attr, value) :param attr: Attribute name to sets its value. :type attr: str :param value: Attribute value to set . :type value: str

setValues(**kwds)#

setattr on name and value pairs in order Attributes are defined

Args: **kwds: To set attibures in one go

property type#: The type of the system.

property visible#

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.

wasValueSet(attr)#

Check if attribute was set

Parameters:: attr (str) – Attribute name to check it value set or not
Returns:: True, if value was set else false.
Return type:: bool