Table of Contents

Class Application

Namespace
HyperX.Scripting
Assembly
HyperX.Scripting.dll
public sealed class Application : IDisposable
Inheritance
Application
Implements
Inherited Members

Constructors

Application(UnitSystem, int?) 

public Application(UnitSystem unitSystem = UnitSystem.English, int? threadCount = null)

Parameters

unitSystem UnitSystem
threadCount int?

Properties

ActiveProject 

public Project ActiveProject { get; }

Property Value

Project

AnalysisProperties 

public AnalysisPropertyCol AnalysisProperties { get; }

Property Value

AnalysisPropertyCol

CompilationDate 

public static string CompilationDate { get; }

Property Value

string

DatabasePath 

public string DatabasePath { get; }

Property Value

string

DesignProperties 

public DesignPropertyCol DesignProperties { get; }

Property Value

DesignPropertyCol

FailureModeCategories 

public FailureModeCategoryCol FailureModeCategories { get; }

Property Value

FailureModeCategoryCol

FailureModes 

public FailureModeCol FailureModes { get; }

Property Value

FailureModeCol

Foams 

public FoamCol Foams { get; }

Property Value

FoamCol

Honeycombs 

public HoneycombCol Honeycombs { get; }

Property Value

HoneycombCol

Isotropics 

public IsotropicCol Isotropics { get; }

Property Value

IsotropicCol

LaminateFamilies 

public LaminateFamilyCol LaminateFamilies { get; }

Property Value

LaminateFamilyCol

Laminates 

public LaminateCol Laminates { get; }

Property Value

LaminateCol

LoadProperties 

public LoadPropertyCol LoadProperties { get; }

Property Value

LoadPropertyCol

Orthotropics 

public OrthotropicCol Orthotropics { get; }

Property Value

OrthotropicCol

Packages 

public PluginPackageCol Packages { get; }

Property Value

PluginPackageCol

ProjectInfos 

public ProjectInfoCol ProjectInfos { get; }

Property Value

ProjectInfoCol

UiRunnerMode 

public bool UiRunnerMode { get; }

Property Value

bool

UnitSystem 

public UnitSystem UnitSystem { get; }

Property Value

UnitSystem

UserName 

public string UserName { get; set; }

Property Value

string

Version 

public static string Version { get; }

Property Value

string

Methods

CheckDatabaseIsUpToDate(string) 

public bool CheckDatabaseIsUpToDate(string databasePath)

Parameters

databasePath string

Returns

bool

CloseDatabase(int) 

public void CloseDatabase(int delay = 1)

Parameters

delay int

CompareDatabases(string, string, string, string, string, bool, bool, bool) 

public SimpleStatus CompareDatabases(string outputPath, string originalDatabasePath, string modifiedDatabasePath, string originalProject = null, string modifiedProject = null, bool compareAssignableProperties = true, bool compareMaterialsFastenersAndRivets = true, bool compareProjectSetup = false)

Parameters

outputPath string
originalDatabasePath string
modifiedDatabasePath string
originalProject string
modifiedProject string
compareAssignableProperties bool
compareMaterialsFastenersAndRivets bool
compareProjectSetup bool

Returns

SimpleStatus

CopyProject(int, string, bool, bool, bool, bool) 

public ProjectInfo CopyProject(int projectId, string newName = null, bool copyDesignProperties = true, bool copyAnalysisProperties = true, bool copyLoadProperties = true, bool copyWorkingFolder = true)

Parameters

projectId int
newName string
copyDesignProperties bool
copyAnalysisProperties bool
copyLoadProperties bool
copyWorkingFolder bool

Returns

ProjectInfo

CreateDatabaseFromTemplate(string, string) 

public void CreateDatabaseFromTemplate(string templateName, string newPath)

Parameters

templateName string
newPath string

CreateHyperXpertPoints(HashSet<RunSetSpecifier>, DoePlotMode, DoePointType, bool, bool) 

public List<HyperXpertPoint> CreateHyperXpertPoints(HashSet<RunSetSpecifier> runSetSpecifiers, DoePlotMode plotMode, DoePointType pointType, bool generateVariabilityForLinked, bool filterNonGeometry)

Parameters

runSetSpecifiers HashSet<RunSetSpecifier>
plotMode DoePlotMode
pointType DoePointType
generateVariabilityForLinked bool
filterNonGeometry bool

Returns

List<HyperXpertPoint>

CreateProject(string) 

public ProjectInfo CreateProject(string projectName = null)

Parameters

projectName string

Returns

ProjectInfo

DeleteProject(string) 

public ProjectDeletionStatus DeleteProject(string projectName)

Parameters

projectName string

Returns

ProjectDeletionStatus

Dispose() 

public void Dispose()

GetAnalyses() 

[Obsolete("This method is slated to be deleted. Do not use.")]
public Dictionary<int, AnalysisDefinition> GetAnalyses()

Returns

Dictionary<int, AnalysisDefinition>

GetRunSetsByProject() 

public Dictionary<int, List<RunSet>> GetRunSetsByProject()

Returns

Dictionary<int, List<RunSet>>

ImportMaterialsFromExcel(string, bool, bool) 

public SimpleStatus ImportMaterialsFromExcel(string filePath, bool deletePlies = false, bool updateMaterialsInUseInOtherProjects = false)

Parameters

filePath string
deletePlies bool
updateMaterialsInUseInOtherProjects bool

Returns

SimpleStatus

Login(string, string) 

public void Login(string userName, string password = "")

Parameters

userName string
password string

Migrate(string) 

public string Migrate(string databasePath)

Parameters

databasePath string

Returns

string

OpenDatabase(string) 

public void OpenDatabase(string databasePath)

Parameters

databasePath string

PauseUpdates() 

public void PauseUpdates()

ResumeUpdates() 

public void ResumeUpdates()

SelectProject(string) 

public Project SelectProject(string projectName)

Parameters

projectName string

Returns

Project

UnpackageProject(string, string, bool, bool, bool, bool) 

public SimpleStatus UnpackageProject(string sourcePackagePath, string destinationFolder = null, bool includeFemInputOutputFiles = true, bool includeWorkingFolder = true, bool includeLoadFiles = true, bool includeAdditionalFiles = true)

Parameters

sourcePackagePath string
destinationFolder string
includeFemInputOutputFiles bool
includeWorkingFolder bool
includeLoadFiles bool
includeAdditionalFiles bool

Returns

SimpleStatus

Events

MessageLog 

public event Action<string> MessageLog

Event Type

Action<string>