Click or drag to resize

E3DWriter Class

A writer that exports a simulation Document to a file to be executed by EMA3D.
Inheritance Hierarchy
SystemObject
  ema3d.Api.V25.Core.ExecutionE3DWriter

Namespace: ema3d.Api.V25.Core.Execution
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0
Syntax
Copy
public sealed class E3DWriter

The E3DWriter type exposes the following members.

Methods
 NameDescription
Public methodStatic memberCreate Creates a new standard .emin file writer for the provided document.
Public methodStatic memberCreateSParameter Creates a new s-parameter .emin file writer for the provided document.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodStatic memberGetSim Gets Current simulation
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWrite Exports the .emin file to an arbitrary directory.
Public methodWrite(CancellationToken) Exports the .emin file to an arbitrary directory.
Public methodWrite(String) Exports the .emin file to the provided directory.
Public methodWrite(String, CancellationToken) Exports the .emin file to the provided directory.
Public methodStatic memberWrite(Document, Simulation, String) Exports a standard .emin file for the provided document.
Public methodStatic memberWriteSParameter Exports a s-parameter .emin file for the provided document.
Top
Events
 NameDescription
Public eventWarningThrown Occurs when a warning is thrown while processing a simulation document for export.
Top
Example
Python
Copy
from ema3d.Api.V25.Core.Execution import E3DWriter as E3DWriter
# Write out a configuration file
doc = Window.ActiveWindow.Document
writer = E3DWriter.Create(doc, E3DWriter.GetSim())
writer.Write() # Write to a new sim directory
See Also