hyperx.api.Application Class Reference

Public Member Functions
	__init__ (self, _api.Application application)
bool	CheckDatabaseIsUpToDate (self, str databasePath)
	Returns true if the database version matches the version of this scripting API.
None	CloseDatabase (self, int delay=0)
	Close the currently open database if one exists.
types.SimpleStatus	CompareDatabases (self, str outputPath, str originalDatabasePath, str modifiedDatabasePath, str originalProject=None, str modifiedProject=None, bool compareAssignableProperties=True, bool compareMaterialsFastenersAndRivets=True, bool compareProjectSetup=False)
ProjectInfo	CopyProject (self, int projectId, str newName=None, bool copyDesignProperties=True, bool copyAnalysisProperties=True, bool copyLoadProperties=True, bool copyWorkingFolder=True)
	Copy a project.
None	CreateDatabaseFromTemplate (self, str templateName, str newPath)
	Create a new database.
ProjectInfo	CreateProject (self, str projectName=None)
	Create a Project.
ProjectDeletionStatus	DeleteProject (self, str projectName)
None	Dispose (self)
	Dispose of the application.
dict[int, AnalysisDefinition]	GetAnalyses (self)
	Get all Analysis Definitions in the database.
None	Login (self, str userName, str password="")
	Login to the Scripting API with a specified username and password.
str	Migrate (self, str databasePath)
	Migrate the database to the latest version.
None	OpenDatabase (self, str databasePath)
	Open a database to manipulate with the API.
Project	SelectProject (self, str projectName)
	Select the active project.
types.SimpleStatus	UnpackageProject (self, str sourcePackagePath, str destinationFolder=None, bool includeFemInputOutputFiles=True, bool includeWorkingFolder=True, bool includeLoadFiles=True, bool includeAdditionalFiles=True)
	Unpackage the source .hxp package into the destination folder.

Protected Attributes
	_Entity = application._Entity

Properties
	ActiveProject = property
	Represents a HyperX project within a database.
	AnalysisProperties = property
	CompilationDate = property
	DatabasePath = property
	DesignProperties = property
	FailureModeCategories = property
	FailureModes = property
	Foams = property
	Contains a set of all foam materials in a database.
	Honeycombs = property
	Contains a set of all honeycomb materials in a database.
	Isotropics = property
	Contains a set of all isotropic materials in a database.
	LaminateFamilies = property
	Laminates = property
	LoadProperties = property
	Orthotropics = property
	Contains a set of all orthotropic materials in a database.
	Packages = property
	ProjectInfos = property
	Contains a set of all projects in a database.
	UiRunnerMode = property
	UnitSystem = property
	Unit system specified when starting a scripting Application.
	UserName = property
	Version = property

Constructor & Destructor Documentation

__init__()

hyperx.api.Application.__init__	(		self,
		_api.Application	application )

Member Function Documentation

CheckDatabaseIsUpToDate()

bool hyperx.api.Application.CheckDatabaseIsUpToDate	(		self,
		str	databasePath )

Returns true if the database version matches the version of this scripting API.

Otherwise returns false.

CloseDatabase()

None hyperx.api.Application.CloseDatabase	(		self,
		int	delay = 0 )

Close the currently open database if one exists.

Parameters

delay

Delay closing the connection for this many seconds.

CompareDatabases()

types.SimpleStatus hyperx.api.Application.CompareDatabases	(		self,
		str	outputPath,
		str	originalDatabasePath,
		str	modifiedDatabasePath,
		str	originalProject = None,
		str	modifiedProject = None,
		bool	compareAssignableProperties = True,
		bool	compareMaterialsFastenersAndRivets = True,
		bool	compareProjectSetup = False )

CopyProject()

ProjectInfo hyperx.api.Application.CopyProject	(		self,
		int	projectId,
		str	newName = None,
		bool	copyDesignProperties = True,
		bool	copyAnalysisProperties = True,
		bool	copyLoadProperties = True,
		bool	copyWorkingFolder = True )

Copy a project.

Parameters

projectId	Id of the project to copy
newName	Name for the new project
copyDesignProperties	Flag indicating whether design properties should be copied in the new project
copyAnalysisProperties	Flag indicating whether analysis properties should be copied in the new project
copyLoadProperties	Flag indicating whether load properties should be copied in the new project
copyWorkingFolder	Flag indicating whether working folder should be copied

CreateDatabaseFromTemplate()

None hyperx.api.Application.CreateDatabaseFromTemplate	(		self,
		str	templateName,
		str	newPath )

Create a new database.

Parameters

templateName	The name of the template to base this database on.
newPath	The path to the new database.

CreateProject()

ProjectInfo hyperx.api.Application.CreateProject	(		self,
		str	projectName = None )

Create a Project.

DeleteProject()

ProjectDeletionStatus hyperx.api.Application.DeleteProject	(		self,
		str	projectName )

Dispose()

None hyperx.api.Application.Dispose

(

self

)

Dispose of the application.

Should be explicitly called after the application is no longer needed unless the application is wrapped with a using clause.

GetAnalyses()

dict[int, AnalysisDefinition] hyperx.api.Application.GetAnalyses

(

self

)

Get all Analysis Definitions in the database.

Login()

None hyperx.api.Application.Login	(		self,
		str	userName,
		str	password = "" )

Login to the Scripting API with a specified username and password.

Parameters

userName	Username to login with.
password	Password to log in with

Migrate()

str hyperx.api.Application.Migrate	(		self,
		str	databasePath )

Migrate the database to the latest version.

OpenDatabase()

None hyperx.api.Application.OpenDatabase	(		self,
		str	databasePath )

Open a database to manipulate with the API.

Parameters

databasePath

File path to the DB.

SelectProject()

Project hyperx.api.Application.SelectProject	(		self,
		str	projectName )

Select the active project.

Activating a project will deactivate the current project (if present).

UnpackageProject()

types.SimpleStatus hyperx.api.Application.UnpackageProject	(		self,
		str	sourcePackagePath,
		str	destinationFolder = None,
		bool	includeFemInputOutputFiles = True,
		bool	includeWorkingFolder = True,
		bool	includeLoadFiles = True,
		bool	includeAdditionalFiles = True )

Unpackage the source .hxp package into the destination folder.

Note, the destination folder should be empty.

Member Data Documentation

_Entity

hyperx.api.Application._Entity = application._Entity

protected

Property Documentation

ActiveProject

hyperx.api.Application.ActiveProject = property

static

Represents a HyperX project within a database.

AnalysisProperties

hyperx.api.Application.AnalysisProperties = property

static

CompilationDate

hyperx.api.Application.CompilationDate = property

static

DatabasePath

hyperx.api.Application.DatabasePath = property

static

DesignProperties

hyperx.api.Application.DesignProperties = property

static

FailureModeCategories

hyperx.api.Application.FailureModeCategories = property

static

FailureModes

hyperx.api.Application.FailureModes = property

static

Foams

hyperx.api.Application.Foams = property

static

Contains a set of all foam materials in a database.

Honeycombs

hyperx.api.Application.Honeycombs = property

static

Contains a set of all honeycomb materials in a database.

Isotropics

hyperx.api.Application.Isotropics = property

static

Contains a set of all isotropic materials in a database.

LaminateFamilies

hyperx.api.Application.LaminateFamilies = property

static

Laminates

hyperx.api.Application.Laminates = property

static

LoadProperties

hyperx.api.Application.LoadProperties = property

static

Orthotropics

hyperx.api.Application.Orthotropics = property

static

Contains a set of all orthotropic materials in a database.

Packages

hyperx.api.Application.Packages = property

static

ProjectInfos

hyperx.api.Application.ProjectInfos = property

static

Contains a set of all projects in a database.

UiRunnerMode

hyperx.api.Application.UiRunnerMode = property

static

UnitSystem

hyperx.api.Application.UnitSystem = property

static

Unit system specified when starting a scripting Application.

UserName

hyperx.api.Application.UserName = property

static

Version

hyperx.api.Application.Version = property

static

---

The documentation for this class was generated from the following file:

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py