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

Public Member Functions
	__init__ (self, _api.Project project)
types.TernaryStatus	AnalyzeZones (self)
	Analyze a list of zones by ID.
types.TernaryStatus	AnalyzeZones (self, item1=None)
types.TernaryStatus	AnalyzeZones (self, tuple[int] zoneIds)
	Analyze a list of zones by ID.
types.TernaryStatus	AnalyzeZones (self, tuple[ZoneBase] zones)
	Analyze a list of zones.
None	CancelAnalysis (self)
types.SimpleStatus	CopyResultsToOverrides (self, bool forceDeletePlies, tuple[int] zoneIds)
types.SimpleStatus	CopyResultsToOverrides (self, bool forceDeletePlies, tuple[ZoneBase] zones)
types.SimpleStatus	CopyResultsToOverrides (self, item1=None, item2=None)
list[HyperXpertPoint]	CreateHyperXpertPoints (self, set[int] runsets, types.DoePlotMode plotMode, types.DoePointType pointType, bool generateVariabilityForLinked, bool filterNonGeometry)
	Create HyperXpert points based on specific run sets.
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)
	Export all CAD for this project to a file.
None	ExportCad (self, tuple[int] cadIds, str filePath)
	Export CAD by Id.
None	ExportFem (self, str destinationFolder)
types.SimpleStatus	FullRunSolverAnalysis (self, str inputFile=None, str outputFile=None, set[int] zones=None, set[int] joints=None, set[int] sectionCuts=None, set[int] panelSegments=None, int nThreads=None)
	Run solver in analysis mode with the specified items targeted.
types.SimpleStatus	FullRunSolverSizing (self, str inputFile=None, str outputFile=None, set[int] zones=None, set[int] joints=None, set[int] sectionCuts=None, set[int] panelSegments=None, int nThreads=None)
	Run solver in sizing mode with the specified items targeted.
types.SimpleStatus	GenerateCae (self, str outputFile, int designPropertyId, int analysisPropertyId, int loadPropertyId, float zoneSpanX, float zoneSpanY, bool isCurved=False, float curvatureRadius=None, types.ZoneBucklingMode zoneBucklingMode=types.ZoneBucklingMode.InternalY)
	Generates a CAE file for the given parameters.
None	GeneratePeakLoadFiles (self, set[int] zones)
str	GenerateSolverAnalysisInputFile (self, str inputFile=None, set[int] zones=None, set[int] joints=None, set[int] sectionCuts=None, set[int] panelSegments=None)
	Generate analysis input file for solver with the specified items targeted.
str	GenerateSolverSizingInputFile (self, str inputFile=None, set[int] zones=None, set[int] joints=None, set[int] sectionCuts=None, set[int] panelSegments=None)
	Generate sizing input file for solver with the specified items targeted.
dict[int, AnalysisResultCol]	GetControllingResultsPerCriterion (self)
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]	GetExcludedElements (self)
	Get the elements that are excluded from sizing/analysis.
set[int]	GetJointsWithoutResults (self, tuple[Joint] joints)
	Given a list of joints, returns the ids of the joints that were passed in but did not have results.
list[RunSet]	GetRunSets (self)
None	ImportCad (self, str filePath)
	Import CAD from a file.
str	ImportFeaResults (self, bool alwaysImport=False)
	Manually import design loads.
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, types.BundlePackageInclusionMode bundlePackageInclusionMode=types.BundlePackageInclusionMode.Used)
	Create a .hxp project package from the ActiveProject.
types.SimpleStatus	ReadSolverResultFile (self, bool isSizing, str outputFile)
	Read results from output file, given approach, design properties lookup, and global design variable lookup.
None	RegeneratePfem (self)
	Regenerates and displays the preview FEM.
types.SimpleStatus	ReimportFem (self, bool updateFemInStructures, bool archiveProject, types.FemMappingType femMappingType)
	Run reimport FEM process.
None	ReturnToUnusedFem (self, tuple[int] zoneNumbers=None, tuple[int] jointIds=None)
	Return zones to unused FEM or delete non-FEA zones.
types.SimpleStatus	RunSolver (self, str inputFile, str outputFile=None, int nThreads=None)
	Run solver with pre-generated input file.
None	SetExcludedElements (self, set[int] excludedElements)
	Set the elements that are excluded from sizing/analysis.
None	SetFemFormat (self, types.ProjectModelFormat femFormat)
SetUnitsStatus	SetFemUnits (self, DbForceUnit femForceId, DbLengthUnit femLengthId, DbMassUnit femMassId, DbTemperatureUnit femTemperatureId)
types.SimpleStatus	SizeJoints (self, tuple[Joint] joints=None)
	Size a list of joints.
types.TernaryStatus	SizeZones (self)
	Size a list of zones.
types.TernaryStatus	SizeZones (self, item1=None)
types.TernaryStatus	SizeZones (self, tuple[int] zoneIds)
	Size a list of zones by ID.
types.TernaryStatus	SizeZones (self, tuple[ZoneBase] zones)
	Size a list of zones.
Task	UnimportFemAsync (self)
types.SimpleStatus	Upload (self, str uploadSetName, str company, str program, tuple[str] tags, str notes, set[int] zoneIds, set[int] jointIds)
	Does some checks to make sure the given parameters are valid, then uploads the given zones and joints to the Dashboard.

Protected Attributes
	_Entity = project

Static Protected Attributes
	_FemDataSet
	_HyperFea
	_SolverSettings

Properties
	AnalysisProperties = property
	Analysis Properties for this project.
	Beams = property
	DesignLoads = property
	DesignLoadSubcases = property
	All available subcases for the project.
	DesignLoadTemperatureProfiles = property
	DesignProperties = property
	Design properties for this project.
	DiscreteFieldTables = property
	FemDataSet = property
	FemFormat = property
	HyperFea = property
	Id = property
	Joints = property
	LoadProperties = property
	Load Properties for this project.
	Name = property
	Panels = property
	PanelSegments = property
	Rundecks = property
	SectionCuts = property
	Sets = property
	SolverSettings = 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/4]

types.TernaryStatus hyperx.api.Project.AnalyzeZones ( self )

Analyze a list of zones by ID.

Marked as success if sizing completes normally or with warnings.

◆ AnalyzeZones() [2/4]

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

Analyze a list of zones. Marked as success if sizing completes normally or with warnings.

Analyze a list of zones by ID. Marked as success if sizing completes normally or with warnings.

◆ AnalyzeZones() [3/4]

types.TernaryStatus hyperx.api.Project.AnalyzeZones	(		self,
		tuple[int]	zoneIds )

Analyze a list of zones by ID.

Marked as success if sizing completes normally or with warnings.

◆ AnalyzeZones() [4/4]

types.TernaryStatus hyperx.api.Project.AnalyzeZones	(		self,
		tuple[ZoneBase]	zones )

Analyze a list of zones.

Marked as success if sizing completes normally or with warnings.

◆ CancelAnalysis()

None hyperx.api.Project.CancelAnalysis ( self )

◆ CopyResultsToOverrides() [1/3]

types.SimpleStatus hyperx.api.Project.CopyResultsToOverrides	(		self,
		bool	forceDeletePlies,
		tuple[int]	zoneIds )

◆ CopyResultsToOverrides() [2/3]

types.SimpleStatus hyperx.api.Project.CopyResultsToOverrides	(		self,
		bool	forceDeletePlies,
		tuple[ZoneBase]	zones )

◆ CopyResultsToOverrides() [3/3]

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

◆ CreateHyperXpertPoints()

list[HyperXpertPoint] hyperx.api.Project.CreateHyperXpertPoints	(		self,
		set[int]	runsets,
		types.DoePlotMode	plotMode,
		types.DoePointType	pointType,
		bool	generateVariabilityForLinked,
		bool	filterNonGeometry )

Create HyperXpert points based on specific run sets.

◆ 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 )

Export all CAD for this project to a file.

Export CAD by Id.

◆ ExportCad() [2/3]

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

Export all CAD for this project to a file.

◆ ExportCad() [3/3]

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

Export CAD by Id.

◆ ExportFem()

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

◆ FullRunSolverAnalysis()

types.SimpleStatus hyperx.api.Project.FullRunSolverAnalysis	(		self,
		str	inputFile = None,
		str	outputFile = None,
		set[int]	zones = None,
		set[int]	joints = None,
		set[int]	sectionCuts = None,
		set[int]	panelSegments = None,
		int	nThreads = None )

Run solver in analysis mode with the specified items targeted.

Generates input file, runs solver, reads output. Returns true on success.

◆ FullRunSolverSizing()

types.SimpleStatus hyperx.api.Project.FullRunSolverSizing	(		self,
		str	inputFile = None,
		str	outputFile = None,
		set[int]	zones = None,
		set[int]	joints = None,
		set[int]	sectionCuts = None,
		set[int]	panelSegments = None,
		int	nThreads = None )

Run solver in sizing mode with the specified items targeted.

Generates input file, runs solver, reads output. Returns true on success.

◆ GenerateCae()

types.SimpleStatus hyperx.api.Project.GenerateCae	(		self,
		str	outputFile,
		int	designPropertyId,
		int	analysisPropertyId,
		int	loadPropertyId,
		float	zoneSpanX,
		float	zoneSpanY,
		bool	isCurved = False,
		float	curvatureRadius = None,
		types.ZoneBucklingMode	zoneBucklingMode = types.ZoneBucklingMode.InternalY )

Generates a CAE file for the given parameters.

Parameters

outputFile	Where the sdb will saved
designPropertyId	Design property to use
analysisPropertyId	Analysis property use
loadPropertyId	Load property to use
zoneSpanX	The X span of the temporary zone to use for sizing
zoneSpanY	The Y span of the temporary zone to use for sizing
isCurved	Whether the temporary zone to use for sizing is curved
curvatureRadius	The curvature of the temporary zone to use for sizing
zoneBucklingMode	The buckling mode (direction of the curvature) of the temporary zone to use for sizing

◆ GeneratePeakLoadFiles()

None hyperx.api.Project.GeneratePeakLoadFiles	(		self,
		set[int]	zones )

◆ GenerateSolverAnalysisInputFile()

str hyperx.api.Project.GenerateSolverAnalysisInputFile	(		self,
		str	inputFile = None,
		set[int]	zones = None,
		set[int]	joints = None,
		set[int]	sectionCuts = None,
		set[int]	panelSegments = None )

Generate analysis input file for solver with the specified items targeted.

Returns filepath.

◆ GenerateSolverSizingInputFile()

str hyperx.api.Project.GenerateSolverSizingInputFile	(		self,
		str	inputFile = None,
		set[int]	zones = None,
		set[int]	joints = None,
		set[int]	sectionCuts = None,
		set[int]	panelSegments = None )

Generate sizing input file for solver with the specified items targeted.

Returns filepath.

◆ GetControllingResultsPerCriterion()

dict[int, AnalysisResultCol] hyperx.api.Project.GetControllingResultsPerCriterion ( self )

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

Returns: Returns an array of company names. If certain web related errors are encountered, an empty array will be returned.

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

Returns: Returns an array of program names. If certain web related errors are encountered, an empty array will be returned. If the provided company cannot be found, a None value will be returned.

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

Returns: Returns an array of tag names. If certain web related errors are encountered, an empty array will be returned. If the provided company could not be found, a None value will be returned.

◆ GetExcludedElements()

set[int] hyperx.api.Project.GetExcludedElements ( self )

Get the elements that are excluded from sizing/analysis.

◆ GetJointsWithoutResults()

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

Given a list of joints, returns the ids of the joints that were passed in but did not have results.

If the list of joints is not a subset of the joints passed into the previous joint sizing operation, a new sizing operation will be kicked off.

◆ GetRunSets()

list[RunSet] hyperx.api.Project.GetRunSets ( self )

◆ 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

alwaysImport If true, loads are imported even if loads have already previously been imported.

Returns: Any warnings during import. String with length 0 if no warnings.

Exceptions

InvalidOperationException Throws on failure.

◆ 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,
		types.BundlePackageInclusionMode	bundlePackageInclusionMode = types.BundlePackageInclusionMode.Used )

Create a .hxp project package from the ActiveProject.

◆ ReadSolverResultFile()

types.SimpleStatus hyperx.api.Project.ReadSolverResultFile	(		self,
		bool	isSizing,
		str	outputFile )

Read results from output file, given approach, design properties lookup, and global design variable lookup.

◆ 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

◆ ReimportFem()

types.SimpleStatus hyperx.api.Project.ReimportFem	(		self,
		bool	updateFemInStructures,
		bool	archiveProject,
		types.FemMappingType	femMappingType )

Run reimport FEM process.

Parameters

archiveProject Create a copy of the project before reimporting.

◆ ReturnToUnusedFem()

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

Return zones to unused FEM or delete non-FEA zones.

Exceptions

InvalidOperationException Throws if run sets exist in this project.

◆ RunSolver()

types.SimpleStatus hyperx.api.Project.RunSolver	(		self,
		str	inputFile,
		str	outputFile = None,
		int	nThreads = None )

Run solver with pre-generated input file.

Returns true on success.

◆ SetExcludedElements()

None hyperx.api.Project.SetExcludedElements	(		self,
		set[int]	excludedElements )

Set the elements that are excluded from sizing/analysis.

◆ 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,
		tuple[Joint]	joints = None )

Size a list of joints.

◆ SizeZones() [1/4]

types.TernaryStatus hyperx.api.Project.SizeZones ( self )

Size a list of zones.

Marked as success if sizing completes normally or with warnings.

◆ SizeZones() [2/4]

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

   Size a list of zones.
   Marked as success if sizing completes normally or with warnings.

Parameters

zones	The zones to be sized.
<br>	Size a list of zones. Marked as success if sizing completes normally or with warnings.
<br>	Size a list of zones by ID. Marked as success if sizing completes normally or with warnings.

◆ SizeZones() [3/4]

types.TernaryStatus hyperx.api.Project.SizeZones	(		self,
		tuple[int]	zoneIds )

Size a list of zones by ID.

Marked as success if sizing completes normally or with warnings.

◆ SizeZones() [4/4]

types.TernaryStatus hyperx.api.Project.SizeZones	(		self,
		tuple[ZoneBase]	zones )

Size a list of zones.

Marked as success if sizing completes normally or with warnings.

Parameters

zones The zones to be sized.

◆ UnimportFemAsync()

Task hyperx.api.Project.UnimportFemAsync ( self )

◆ Upload()

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

Does some checks to make sure the given parameters are valid, then uploads the given zones and joints to the Dashboard.

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

Parameters

uploadSetName	The name of the set of data uploaded to the Dashboard.
company	The name of the company to associate with the upload set. This company object must be made through the Dashboard UI.
program	The name of the program to associated with the upload set. A new program will be created if the program name does not already exist.
tags	The list of tags to be associated with the upload set. Any tags that do not exist will be created automatically on upload.
notes	The notes to be associated with the upload set.
zoneIds	The zone IDs to include in the upload set.
jointIds	The joint IDs to include in the upload set.

Returns: Returns a successful SimpleStatus if the upload succeeded. Returns an unsuccessful SimpleStatus with error info otherwise.

Member Data Documentation

◆ _Entity

hyperx.api.Project._Entity = project

protected

◆ _FemDataSet

hyperx.api.Project._FemDataSet

staticprotected

◆ _HyperFea

hyperx.api.Project._HyperFea

staticprotected

◆ _SolverSettings

hyperx.api.Project._SolverSettings

staticprotected

Property Documentation

◆ AnalysisProperties

hyperx.api.Project.AnalysisProperties = property

static

Analysis Properties for this project.

◆ Beams

hyperx.api.Project.Beams = property

static

◆ DesignLoads

hyperx.api.Project.DesignLoads = property

static

◆ DesignLoadSubcases

hyperx.api.Project.DesignLoadSubcases = property

static

All available subcases for the project.

◆ DesignLoadTemperatureProfiles

hyperx.api.Project.DesignLoadTemperatureProfiles = property

static

◆ DesignProperties

hyperx.api.Project.DesignProperties = property

static

Design properties for this project.

◆ 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

Load Properties for this project.

◆ 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

◆ SolverSettings

hyperx.api.Project.SolverSettings = 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

Public Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ AnalyzeZones() [1/4]

◆ AnalyzeZones() [2/4]

◆ AnalyzeZones() [3/4]

◆ AnalyzeZones() [4/4]

◆ CancelAnalysis()

◆ CopyResultsToOverrides() [1/3]

◆ CopyResultsToOverrides() [2/3]

◆ CopyResultsToOverrides() [3/3]

◆ CreateHyperXpertPoints()

◆ CreateNonFeaZone()

◆ Dispose()

◆ ExportCad() [1/3]

◆ ExportCad() [2/3]

◆ ExportCad() [3/3]

◆ ExportFem()

◆ FullRunSolverAnalysis()

◆ FullRunSolverSizing()

◆ GenerateCae()

◆ GeneratePeakLoadFiles()

◆ GenerateSolverAnalysisInputFile()

◆ GenerateSolverSizingInputFile()

◆ GetControllingResultsPerCriterion()

◆ GetDashboardCompanies()

◆ GetDashboardPrograms()

◆ GetDashboardTags()

◆ GetExcludedElements()

◆ GetJointsWithoutResults()

◆ GetRunSets()

◆ ImportCad()

◆ ImportFeaResults()

◆ PackageProject()

◆ ReadSolverResultFile()

◆ RegeneratePfem()

◆ ReimportFem()

◆ ReturnToUnusedFem()

◆ RunSolver()

◆ SetExcludedElements()

◆ SetFemFormat()

◆ SetFemUnits()

◆ SizeJoints()

◆ SizeZones() [1/4]

◆ SizeZones() [2/4]

◆ SizeZones() [3/4]

◆ SizeZones() [4/4]

◆ UnimportFemAsync()

◆ Upload()

Member Data Documentation

◆ _Entity

◆ _FemDataSet

◆ _HyperFea

◆ _SolverSettings

Property Documentation

◆ AnalysisProperties

◆ Beams

◆ DesignLoads

◆ DesignLoadSubcases

◆ DesignLoadTemperatureProfiles

◆ DesignProperties

◆ DiscreteFieldTables

◆ FemDataSet

◆ FemFormat

◆ HyperFea

◆ Id

◆ Joints

◆ LoadProperties

◆ Name

◆ Panels

◆ PanelSegments

◆ Rundecks

◆ SectionCuts

◆ Sets

◆ SolverSettings

◆ init()