HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.LoadProperty Class Reference
Inheritance diagram for hyperx.api.LoadProperty:
hyperx.api.AssignableProperty hyperx.api.IdNameEntity hyperx.api.IdEntity hyperx.api.LoadPropertyFea hyperx.api.LoadPropertyUserFeaBeam hyperx.api.LoadPropertyUserFeaJoint hyperx.api.LoadPropertyUserFeaPanel hyperx.api.LoadPropertyUserGeneralBeam hyperx.api.LoadPropertyUserGeneralBolted hyperx.api.LoadPropertyUserGeneralBonded hyperx.api.LoadPropertyUserGeneralPanel

Public Member Functions

 __init__ (self, _api.LoadProperty loadProperty)
PropertyAssignmentStatus AssignTo (self, tuple[int] entityIds, types.FamilyCategory category)
 Assign this hyperx.api.LoadProperty to entities represented by entityIds.
LoadProperty Copy (self)
 Creates and returns a copy of this hyperx.api.LoadProperty.
Public Member Functions inherited from hyperx.api.AssignableProperty
 __init__ (self, _api.AssignableProperty assignableProperty)
Public Member Functions inherited from hyperx.api.IdNameEntity
 __init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
 __init__ (self, _api.IdEntity idEntity)

Properties

 Category = property
 The hyperx.api.types.FamilyCategory of the hyperx.api.LoadProperty.
 IsZeroCurvature = property
 Explains where the moment reference is relative to for User FEA or User General Panel Loads.
 ModificationDate = property
 Type = property
 The hyperx.api.types.LoadPropertyType of the hyperx.api.LoadProperty.
Properties inherited from hyperx.api.IdNameEntity
 Name = property
Properties inherited from hyperx.api.IdEntity
 Id = property

Additional Inherited Members

Protected Attributes inherited from hyperx.api.IdEntity
 _Entity = idEntity

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.LoadProperty.__init__ ( self,
_api.LoadProperty loadProperty )

Member Function Documentation

◆ AssignTo()

PropertyAssignmentStatus hyperx.api.LoadProperty.AssignTo ( self,
tuple[int] entityIds,
types.FamilyCategory category )

Assign this hyperx.api.LoadProperty to entities represented by entityIds.

Returns
hyperx.api.PropertyAssignmentStatus.Success if the assignment is successful.

◆ Copy()

LoadProperty hyperx.api.LoadProperty.Copy ( self)

Creates and returns a copy of this hyperx.api.LoadProperty.

Returns
The new copied hyperx.api.LoadProperty.

Property Documentation

◆ Category

hyperx.api.LoadProperty.Category = property
static

◆ IsZeroCurvature

hyperx.api.LoadProperty.IsZeroCurvature = property
static

Explains where the moment reference is relative to for User FEA or User General Panel Loads.

Returns
True if moment reference is relative to zero curvature or False to indicate the moment reference is relative to the panel reference plane.

◆ ModificationDate

hyperx.api.LoadProperty.ModificationDate = property
static

◆ Type

hyperx.api.LoadProperty.Type = property
static

The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py