DisplacementConstraint (hwx.inspire.core)

Displacement constraints can be applied to a model to limit deflections in desired locations and directions.

Attributes

active: Bool	boundDirection: Enum	color: Color
connectionRadius: Double	connectionType: Enum	direction: Direction
distributed: Bool	features: Attribute	hasLowerBound: Bool
hasUpperBound: Bool	localToPart: Bool	location: Location
lowerBound: Double	mode: Enum	name: Attribute
part: Attribute	parts: Attribute	upperBound: Double
visible: Bool

Properties

position

Public Methods

classmethod getClass (cls, className)

classmethod importLoads (cls, csvFile)

__new__ (cls, features, location=None, upperBound=0.01, lowerBound=-0.01, name=’’, isRemote=False, **kwds)

destroy (self)

getAllChildren (self, type=None, **kwds)

getChild (self, name=None, recursive=False, **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)

updatePosition (self, m44)

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.

boundDirection : Enum (all, one)

Limit to a sphere (all) or along a line (one). Valid choices are:

• all

• one

color : Color

The color assigned to the boundary condition.

connectionRadius : Double (units=”length”)

The search radius for the boundary condition.

connectionType : Enum (Rigid, Flexible)

The type of the connection. Valid choices are:

• Rigid

• Flexible

direction : Direction

Determines the z axis of the position along which limits are applied if boundDirection is one.

distributed : Bool

Returns whether the applied boundary condition is distributed or not.

Boundary conditions applied across the entire feature area (for faces) or length (for edges) are distributed and at a single point boundary conditions are non-distributed.

features : Attribute

The list of features to which the boundary condition is applied.

hasLowerBound : Bool

Determines whether it has a lower bound.

hasUpperBound : Bool

Determines whether it has an upper bound.

localToPart : Bool

Returns or sets ‘Rotate with part’.

It makes boundary condition not to rotate or rotate along with its associated part.

location : Location (units=”length”)

The location of the boundary condition.

lowerBound : Double (units=”length”)

The lower limit.

Ignored if boundDirection==all

mode : Enum (direction, components)

Specifies the mode of the boundary condition.

Valid choices are:

• direction

• components

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.

part : Attribute

Returns the part on which the entity is applied graphically.

parts : Attribute

The list of parts on which the boundary condition is applied.

upperBound : Double (units=”length”)

Limit sphere radius if boundDirection==all or upper limit

visible : Bool

Determines whether the boundary condition is visible or not.

Property Details

property position

Matrix44: The location and orientation.

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..]

classmethod importLoads(cls, csvFile)

Imports boundary conditions to the active model from a csv file.

param csvFile

Csv file name containing all the BC information.

type csvFile

str

returns

List of error msgs that happened during import of all the boundary conditions.

rtype

list

__new__(cls, features, location=None, upperBound=0.01, lowerBound=- 0.01, name='', isRemote=False, **kwds)

Creates displacement constraint on supplied features and location.

param features

List of features on which Displacement constraint is applied.

type features

list[Feature]

param location

Location of the displacement constraint.

type location

Point

param upperBound

The upper bound for the displacement constraint.

type upperBound

float

param lowerBound

The lower bound for the displacement constraint.

type lowerBound

float

param name

Name of displacement constraint.

type name

str

param isRemote

Specify load as remote.

type isRemote

bool

param **kwds

To set other attributes to the bc. e.g.: color=”red”.

returns

Returns created displacement constraint.

rtype

DisplacementConstraint

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.

updatePosition(self, m44)

Update the position by multiplying input M44 matrix.