HarnessSimulation Class

A single or multi-run MHARNESS simulation.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25.Core.ExecutionSubProcessBase
ema3d.Api.V25.Core.ExecutionHarnessSimulation

Namespace: ema3d.Api.V25.Core.Execution
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class HarnessSimulation : SubProcessBase

Public NotInheritable Class HarnessSimulation
	Inherits SubProcessBase

public ref class HarnessSimulation sealed : public SubProcessBase

[<SealedAttribute>]
type HarnessSimulation = 
    class
        inherit SubProcessBase
    end

The HarnessSimulation type exposes the following members.

Properties

	Name	Description
	EndTime	Gets time that the process finished or current time if process is still running. (Inherited from SubProcessBase)
	Progress	Gets the current percent completion of process [0 - 100]. (Inherited from SubProcessBase)
	StartTime	Gets time that the process was started. (Inherited from SubProcessBase)
	Status	Gets current status of the process. (Inherited from SubProcessBase)

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SubProcessBase)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Kill	Kills the process. (Inherited from SubProcessBase)
	Launch	Starts a standard MHARNESS simulation using the provided input file.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WaitForCompletion	Blocks until the process finishes. (Inherited from SubProcessBase)
	WaitForCompletion(CancellationToken)	Blocks until the process finishes. (Inherited from SubProcessBase)

Top

Events

	Name	Description
	MessageReceived	Occurs when some message is received from the process. (Inherited from SubProcessBase)

Top

Example

Python

Copy

from ema3d.Api.V25.Core.Execution import HarnessSimulation as HarnessSimulation
# Run simulation from filepath
_filepath = r"C:\Users\Example Simulation\Harness.inp"
_sim = HarnessSimulation.Launch(_filepath).WaitForCompletion()

Reference

ema3d.Api.V25.Core.Execution Namespace