Class FieldRepresentationObject

Namespace

VirtualLabAPI.Core.FieldRepresentations

Assembly

VirtualLabAPI.dll

Abstract base class for all field representations.

[Serializable]
public abstract class FieldRepresentationObject : ManualSerialization, ISerializable, IDeserializationCallback, IDocument, IEquatable<IObjectBase>, ICloneable, IDisposable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

FieldRepresentationObject

Implements

ISerializable

IDeserializationCallback

IDocument

IEquatable<IObjectBase>

ICloneable

IDisposable

Derived

HarmonicFieldBase

RigorousSimulationResultBase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FileHandlingSupport.SaveCompressed(IStorableOnHDD, string, ListOfSavedViewSettings)

Constructors

FieldRepresentationObject()

Standard constructor.

public FieldRepresentationObject()

FieldRepresentationObject(FieldRepresentationObject)

Copy constructor.

public FieldRepresentationObject(FieldRepresentationObject fro)

Parameters

fro FieldRepresentationObject

Field representation object to copy.

Properties

EmbeddingMedium

Medium the light field object is located in.

public HomogeneousMedium EmbeddingMedium { get; set; }

Property Value

HomogeneousMedium

FieldRepresentation

Gets the type of the field representation.

public abstract FieldRepresentation FieldRepresentation { get; }

Property Value

FieldRepresentation

FileExtension

Gets the file extension.

public abstract string FileExtension { get; }

Property Value

string

TypeOfDocument

The type of the document.

public abstract DocumentType TypeOfDocument { get; }

Property Value

DocumentType

Methods

Clone()

Clones the current object.

public override object Clone()

Returns

object

Deep copy of this object.

Equals(object, EqualityIntent)

Determines whether the specified object is equal to this instance.

public override bool Equals(object otherObject, EqualityIntent equalityIntent)

Parameters

otherObject object

The object to compare with this instance.

equalityIntent EqualityIntent

Defines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

Save(string)

Implementation of the IDocument Save function.

public abstract void Save(string filename)

Parameters

filename string

Path and file name.