E3DWriter Class

A writer that exports a simulation Document to a file to be executed by EMA3D.

Inheritance Hierarchy

SystemObject
ema3d.Api.V26.Core.ExecutionE3DWriter

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

Syntax

C++

Copy

public sealed class E3DWriter

Public NotInheritable Class E3DWriter

public ref class E3DWriter sealed

[<SealedAttribute>]
type E3DWriter = class end

The E3DWriter type exposes the following members.

Methods

	Name	Description
	Create(Document)	Creates a new .emin file writer for the provided document.
	Create(Document, Simulation)	This method is deprecated and will soon be removed. Creates a new standard .emin file writer for the provided document.
	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)
	GetSim	Gets Current simulation
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Write	Exports a standard .emin file for the provided document.
	Write(String)	This method is deprecated and will soon be removed. Exports the .emin file to the provided directory.
	Write(String, CancellationToken)	This method is deprecated and will soon be removed. Exports the .emin file to the provided directory.
	Write(Document, Simulation, String)	This method is deprecated and will soon be removed. Exports a standard .emin file for the provided document.
	WriteSParameter	Exports an s-parameter .emin file for the provided document.

Top

Events

	Name	Description
	WarningThrown	Occurs when a warning is thrown while processing a simulation document for export.

Top

Example

Python

Copy

from ema3d.Api.V26.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

Reference

ema3d.Api.V26.Core.Execution Namespace