Table of Contents

Class HarmonicFieldsSetView

Namespace
VirtualLabAPI.Core.FieldRepresentations
Assembly
VirtualLabAPI.dll

Class which combines a harmonic fields set with view settings.

[Serializable]
public class HarmonicFieldsSetView : SerializableObjectBase, IEquatable<IObjectBase>, IDisposable, ICloneable
Inheritance
ObjectBase
SerializableObjectBase
HarmonicFieldsSetView
Implements
IEquatable<IObjectBase>
Inherited Members

Constructors

HarmonicFieldsSetView(HarmonicFieldsSet)

Constructor using default view settings.

public HarmonicFieldsSetView(HarmonicFieldsSet harmonicFieldsSet)

Parameters

harmonicFieldsSet HarmonicFieldsSet

The harmonic fields set with which the class shall be initialized.

HarmonicFieldsSetView(HarmonicFieldsSet, ViewProperties)

Default constructor

public HarmonicFieldsSetView(HarmonicFieldsSet harmonicFieldsSet, ViewProperties viewSettings)

Parameters

harmonicFieldsSet HarmonicFieldsSet

The harmonic fields set with which the class shall be initialized.

viewSettings ViewProperties

The view properties with which the class shall be initialized.

Fields

HarmonicFieldsSet

The underlying harmonic fields set.

public HarmonicFieldsSet HarmonicFieldsSet

Field Value

HarmonicFieldsSet

ViewSettings

The view settings which shall be applied to the harmonic fields set.

public ViewProperties ViewSettings

Field Value

ViewProperties

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override object Clone()

Returns

object

A new object that is a copy of this instance.

Dispose()

Dispose functionality

public void Dispose()

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.

ToString()

overridden ToString() function. Used for parameter run.

public override string ToString()

Returns

string

The name of the object as string.