Programming Reference for VirtualLab Fusion  2025.1
Loading...
Searching...
No Matches
HarmonicFieldsSetView Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class which combines a harmonic fields set with view settings. More...

Inheritance diagram for HarmonicFieldsSetView:

Public Member Functions

override object Clone ()
 Creates a new object that is a copy of the current instance.
 
void Dispose ()
 Dispose functionality.
 
override bool Equals (object otherObject, EqualityIntent equalityIntent)
 Determines whether the specified Object is equal to this instance.
 
 HarmonicFieldsSetView (HarmonicFieldsSet harmonicFieldsSet)
 Constructor using default view settings.
 
 HarmonicFieldsSetView (HarmonicFieldsSet harmonicFieldsSet, ViewProperties viewSettings)
 Default constructor.
 
override string ToString ()
 overridden ToString() function. Used for parameter run.
 

Public Attributes

HarmonicFieldsSet HarmonicFieldsSet
 The underlying harmonic fields set.
 
ViewProperties ViewSettings
 The view settings which shall be applied to the harmonic fields set.
 

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class which combines a harmonic fields set with view settings.

Constructor & Destructor Documentation

◆ HarmonicFieldsSetView() [1/2]

HarmonicFieldsSetView ( HarmonicFieldsSet  harmonicFieldsSet)

Constructor using default view settings.

Parameters
harmonicFieldsSetThe harmonic fields set with which the class shall be initialized.

◆ HarmonicFieldsSetView() [2/2]

HarmonicFieldsSetView ( HarmonicFieldsSet  harmonicFieldsSet,
ViewProperties  viewSettings 
)

Default constructor.

Parameters
harmonicFieldsSetThe harmonic fields set with which the class shall be initialized.
viewSettingsThe view properties with which the class shall be initialized.

Member Function Documentation

◆ Clone()

override object Clone ( )

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

Returns
A new object that is a copy of this instance.

◆ Equals()

override bool Equals ( object  otherObject,
EqualityIntent  equalityIntent 
)

Determines whether the specified Object is equal to this instance.

Parameters
otherObjectThe Object to compare with this instance.
equalityIntentDefines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.
Returns
true if the specified Object is equal to this instance; otherwise, false.

◆ ToString()

override string ToString ( )

overridden ToString() function. Used for parameter run.

Returns
The name of the object as string.