ComplexAmplitudeView 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 complex amplitude with view settings. More...

Inheritance diagram for ComplexAmplitudeView:

Public Member Functions
override object	Clone ()
	Creates a new object that is a copy of the current instance.
	ComplexAmplitudeView (ComplexAmplitude complexAmplitude)
	Constructor using default view settings.
	ComplexAmplitudeView (ComplexAmplitude complexAmplitude, ViewProperties viewSettings)
	Default constructor.
	ComplexAmplitudeView (ComplexAmplitude complexAmplitude, ViewProperties viewSettings, string comment)
	Default constructor.
	ComplexAmplitudeView (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the ComplexAmplitudeView class.
void	Dispose ()
	Dispose functionality.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance.
void	Show (string caption, bool cloneDocument=true, Action< FormDocument > changeFormAfterShow=null)
	Shows the complex amplitude with the corresponding view settings.
override string	ToString ()
	overridden ToString() function. Used for parameter run.

Public Attributes
string	Comment
	Comment to be displayed.
ComplexAmplitude	ComplexAmplitude
	The underlying complex amplitude.

Properties
ViewProperties	ViewSettings [get, set]
	Gets and sets the view settings which shall be applied to the complex amplitude.

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 complex amplitude with view settings.

Constructor & Destructor Documentation

ComplexAmplitudeView() [1/4]

ComplexAmplitudeView

(

ComplexAmplitude

complexAmplitude

)

Constructor using default view settings.

Parameters

complexAmplitude

The complex amplitude with which the class shall be initialized.

ComplexAmplitudeView() [2/4]

ComplexAmplitudeView	(	ComplexAmplitude	complexAmplitude,
		ViewProperties	viewSettings
	)

Default constructor.

Parameters

complexAmplitude	The complex amplitude with which the class shall be initialized.
viewSettings	The view properties with which the class shall be initialized.

ComplexAmplitudeView() [3/4]

ComplexAmplitudeView	(	ComplexAmplitude	complexAmplitude,
		ViewProperties	viewSettings,
		string	comment
	)

Default constructor.

Parameters

complexAmplitude	The complex amplitude with which the class shall be initialized.
viewSettings	The view properties with which the class shall be initialized.
comment	Comment being displayed in parameter run (subdetector)

ComplexAmplitudeView() [4/4]

ComplexAmplitudeView	(	SerializationInfo	info,
		StreamingContext	context
	)

Initializes a new instance of the ComplexAmplitudeView class.

Parameters

info	The info object of the deserialization stream.
context	The context object of the deserialization stream.

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

otherObject	The Object to compare with this instance.
equalityIntent	Defines 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.

Show()

void Show	(	string	caption,
		bool	cloneDocument = true,
		Action< FormDocument >	changeFormAfterShow = null
	)

Shows the complex amplitude with the corresponding view settings.

Parameters

caption	The caption of the shown document.
cloneDocument	If set this optional parameter is set to false this document is shown. Otherwise a cloned copy of this document is shown.
changeFormAfterShow	Optional method which is called after the document window is shown. In this way you can change view settings of the form if required.

ToString()

override string ToString

(

)

overridden ToString() function. Used for parameter run.

Returns

The name of the object as string.

Property Documentation

ViewSettings

ViewProperties ViewSettings

getset

Gets and sets the view settings which shall be applied to the complex amplitude.