HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.Project Class Reference

Represents a HyperX project within a database. More...

Public Member Functions

 __init__ (self, _api.Project project)
types.SimpleStatus AnalyzeZones (self, item1=None)
types.SimpleStatus AnalyzeZones (self, list[int] zoneIds)
types.SimpleStatus AnalyzeZones (self, list[Zone] zones=None)
Zone CreateNonFeaZone (self, types.FamilyCategory category, str name=None)
 Create a non-FEA zone by name and category.
None Dispose (self)
None ExportCad (self, item1=None, item2=None)
None ExportCad (self, str filePath)
None ExportCad (self, tuple[int] cadIds, str filePath)
None ExportFem (self, str destinationFolder)
list[str] GetDashboardCompanies (self)
 This method fetches an array of Dashboard company names that are available to the user who is currently logged in.
list[str] GetDashboardPrograms (self, str companyName)
 This method fetches an array of Dashboard program names that are available to the user who is currently logged in.
list[str] GetDashboardTags (self, str companyName)
 This method fetches an array of Dashboard tags that are available to the user who is currently logged in.
set[int] GetJointsWithoutResults (self, list[Joint] joints)
None ImportCad (self, str filePath)
 Import CAD from a file.
str ImportFeaResults (self, bool alwaysImport=False)
 Manually import design loads.
None ImportFem (self)
types.SimpleStatus PackageProject (self, str destinationFilePath, bool includeFemInputFiles=True, bool includeFemOutputFiles=True, bool includeWorkingFolder=True, bool includeLoadFiles=True, bool includePluginPackages=False, bool removeAllOtherProjects=False, bool deleteUnusedPropertiesAndMaterials=False, bool mapFemFilesToRelativePaths=True, tuple[str] additionalFiles=None)
None RegeneratePfem (self)
 Regenerates and displays the preview FEM.
None ReturnToUnusedFem (self, list[int] zoneNumbers=None, set[int] jointIds=None)
None SetFemFormat (self, types.ProjectModelFormat femFormat)
SetUnitsStatus SetFemUnits (self, DbForceUnit femForceId, DbLengthUnit femLengthId, DbMassUnit femMassId, DbTemperatureUnit femTemperatureId)
types.SimpleStatus SizeJoints (self, list[Joint] joints=None)
types.SimpleStatus SizeZones (self, item1=None)
types.SimpleStatus SizeZones (self, list[int] zoneIds)
types.SimpleStatus SizeZones (self, list[Zone] zones=None)
Task UnimportFemAsync (self)
bool Upload (self, str uploadSetName, str company, str program, list[str] tags, str notes, set[int] zoneIds, set[int] jointIds)

Protected Attributes

 _Entity = project

Properties

 AnalysisProperties = property
 Beams = property
 DesignLoads = property
 DesignProperties = property
 DiscreteFieldTables = property
 FemDataSet = property
 FemFormat = property
 HyperFea = property
 Id = property
 Joints = property
 LoadProperties = property
 Name = property
 Panels = property
 PanelSegments = property
 Rundecks = property
 SectionCuts = property
 Sets = property
 Structures = property
 WorkingFolder = property
 Zones = property

Detailed Description

Represents a HyperX project within a database.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.Project.__init__ ( self,
_api.Project project )

Member Function Documentation

◆ AnalyzeZones() [1/3]

types.SimpleStatus hyperx.api.Project.AnalyzeZones ( self,
item1 = None )

◆ AnalyzeZones() [2/3]

types.SimpleStatus hyperx.api.Project.AnalyzeZones ( self,
list[int] zoneIds )

◆ AnalyzeZones() [3/3]

types.SimpleStatus hyperx.api.Project.AnalyzeZones ( self,
list[Zone] zones = None )

◆ CreateNonFeaZone()

Zone hyperx.api.Project.CreateNonFeaZone ( self,
types.FamilyCategory category,
str name = None )

Create a non-FEA zone by name and category.

◆ Dispose()

None hyperx.api.Project.Dispose ( self)

◆ ExportCad() [1/3]

None hyperx.api.Project.ExportCad ( self,
item1 = None,
item2 = None )

◆ ExportCad() [2/3]

None hyperx.api.Project.ExportCad ( self,
str filePath )

◆ ExportCad() [3/3]

None hyperx.api.Project.ExportCad ( self,
tuple[int] cadIds,
str filePath )

◆ ExportFem()

None hyperx.api.Project.ExportFem ( self,
str destinationFolder )

◆ GetDashboardCompanies()

list[str] hyperx.api.Project.GetDashboardCompanies ( self)

This method fetches an array of Dashboard company names that are available to the user who is currently logged in.

The URL and authentication token are taken from the last Dashboard login made through HyperX.

◆ GetDashboardPrograms()

list[str] hyperx.api.Project.GetDashboardPrograms ( self,
str companyName )

This method fetches an array of Dashboard program names that are available to the user who is currently logged in.

The URL and authentication token are taken from the last Dashboard login made through HyperX.

◆ GetDashboardTags()

list[str] hyperx.api.Project.GetDashboardTags ( self,
str companyName )

This method fetches an array of Dashboard tags that are available to the user who is currently logged in.

The URL and authentication token are taken from the last Dashboard login made through HyperX.

◆ GetJointsWithoutResults()

set[int] hyperx.api.Project.GetJointsWithoutResults ( self,
list[Joint] joints )

◆ ImportCad()

None hyperx.api.Project.ImportCad ( self,
str filePath )

Import CAD from a file.

◆ ImportFeaResults()

str hyperx.api.Project.ImportFeaResults ( self,
bool alwaysImport = False )

Manually import design loads.

Parameters
alwaysImportIf true, loads are imported even if loads have already previously been imported.

◆ ImportFem()

None hyperx.api.Project.ImportFem ( self)

◆ PackageProject()

types.SimpleStatus hyperx.api.Project.PackageProject ( self,
str destinationFilePath,
bool includeFemInputFiles = True,
bool includeFemOutputFiles = True,
bool includeWorkingFolder = True,
bool includeLoadFiles = True,
bool includePluginPackages = False,
bool removeAllOtherProjects = False,
bool deleteUnusedPropertiesAndMaterials = False,
bool mapFemFilesToRelativePaths = True,
tuple[str] additionalFiles = None )

◆ RegeneratePfem()

None hyperx.api.Project.RegeneratePfem ( self)

Regenerates and displays the preview FEM.

If running a script outside of the Script Runner, do not call this method

◆ ReturnToUnusedFem()

None hyperx.api.Project.ReturnToUnusedFem ( self,
list[int] zoneNumbers = None,
set[int] jointIds = None )

◆ SetFemFormat()

None hyperx.api.Project.SetFemFormat ( self,
types.ProjectModelFormat femFormat )

◆ SetFemUnits()

SetUnitsStatus hyperx.api.Project.SetFemUnits ( self,
DbForceUnit femForceId,
DbLengthUnit femLengthId,
DbMassUnit femMassId,
DbTemperatureUnit femTemperatureId )

◆ SizeJoints()

types.SimpleStatus hyperx.api.Project.SizeJoints ( self,
list[Joint] joints = None )

◆ SizeZones() [1/3]

types.SimpleStatus hyperx.api.Project.SizeZones ( self,
item1 = None )

◆ SizeZones() [2/3]

types.SimpleStatus hyperx.api.Project.SizeZones ( self,
list[int] zoneIds )

◆ SizeZones() [3/3]

types.SimpleStatus hyperx.api.Project.SizeZones ( self,
list[Zone] zones = None )

◆ UnimportFemAsync()

Task hyperx.api.Project.UnimportFemAsync ( self)

◆ Upload()

bool hyperx.api.Project.Upload ( self,
str uploadSetName,
str company,
str program,
list[str] tags,
str notes,
set[int] zoneIds,
set[int] jointIds )

Member Data Documentation

◆ _Entity

hyperx.api.Project._Entity = project
protected

Property Documentation

◆ AnalysisProperties

hyperx.api.Project.AnalysisProperties = property
static

◆ Beams

hyperx.api.Project.Beams = property
static

◆ DesignLoads

hyperx.api.Project.DesignLoads = property
static

◆ DesignProperties

hyperx.api.Project.DesignProperties = property
static

◆ DiscreteFieldTables

hyperx.api.Project.DiscreteFieldTables = property
static

◆ FemDataSet

hyperx.api.Project.FemDataSet = property
static

◆ FemFormat

hyperx.api.Project.FemFormat = property
static

◆ HyperFea

hyperx.api.Project.HyperFea = property
static

◆ Id

hyperx.api.Project.Id = property
static

◆ Joints

hyperx.api.Project.Joints = property
static

◆ LoadProperties

hyperx.api.Project.LoadProperties = property
static

◆ Name

hyperx.api.Project.Name = property
static

◆ Panels

hyperx.api.Project.Panels = property
static

◆ PanelSegments

hyperx.api.Project.PanelSegments = property
static

◆ Rundecks

hyperx.api.Project.Rundecks = property
static

◆ SectionCuts

hyperx.api.Project.SectionCuts = property
static

◆ Sets

hyperx.api.Project.Sets = property
static

◆ Structures

hyperx.api.Project.Structures = property
static

◆ WorkingFolder

hyperx.api.Project.WorkingFolder = property
static

◆ Zones

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