IDataDisplay Interface Reference

Interface providing methods to add documents or messages to FormMain. More...

Inheritance diagram for IDataDisplay:

Public Member Functions
void	LogDetectorResult (string detectorName, List< PhysicalValue > results)
	Writes a list of real-valued physical values into the Detector Results tab.
void	LogDetectorResult (string detectorName, List< PhysicalValueBase > results)
	Writes a list of physical values into the Detector Results tab.
void	ShowDocument (IDocument document, bool duplicateDocument=true)
	Displays an IDocument in a document window that supports it. If there is no such window type, an exception is thrown.
void	ShowDocument (IDocument document, string caption, bool duplicateDocument=true)
	Displays an IDocument in a document window that supports it. If there is no such window type, an exception is thrown. Caption of window can be specified.
void	ShowDocumentAsync (IDocument document, string documentCaption="", bool duplicateDocument=true, Action< FormDocument > changeFormAfterShow=null)
	Method to asynchronously show a document in a new MDI child window. Especially useful for output of intermediate results in simulations.
void	ShowNotification (string message, ToolTipIcon toolTipIcon)
	Shows a notification as (balloon) tip in the taskbar notification area (at the right of the Windows™ taskbar).

Detailed Description

Interface providing methods to add documents or messages to FormMain.

Member Function Documentation

LogDetectorResult() [1/2]

void LogDetectorResult	(	string	detectorName,
		List< PhysicalValue >	results
	)

Writes a list of real-valued physical values into the Detector Results tab.

Parameters

detectorName	the name of the detector.
results	the results of the detector (including sub-detectors)

LogDetectorResult() [2/2]

void LogDetectorResult	(	string	detectorName,
		List< PhysicalValueBase >	results
	)

Writes a list of physical values into the Detector Results tab.

Parameters

detectorName	the name of the detector.
results	the results of the detector (including sub-detectors)

ShowDocument() [1/2]

void ShowDocument	(	IDocument	document,
		bool	duplicateDocument = true
	)

Displays an IDocument in a document window that supports it. If there is no such window type, an exception is thrown.

Parameters

document	Document to show.
duplicateDocument	True: A copy of the document is shown. False: The document is shown. This means that when you close the document window the document is also deleted. This optional parameter is true by default.

ShowDocument() [2/2]

void ShowDocument	(	IDocument	document,
		string	caption,
		bool	duplicateDocument = true
	)

Displays an IDocument in a document window that supports it. If there is no such window type, an exception is thrown. Caption of window can be specified.

>

Parameters

document	Document to show.
caption	Caption of window.
duplicateDocument	True: A copy of the document is shown. False: The document is shown. This means that when you close the document window the document is also deleted. This optional parameter is true by default.

ShowDocumentAsync()

void ShowDocumentAsync	(	IDocument	document,
		string	documentCaption = "",
		bool	duplicateDocument = true,
		Action< FormDocument >	changeFormAfterShow = null
	)

Method to asynchronously show a document in a new MDI child window. Especially useful for output of intermediate results in simulations.

Parameters

document	Document to be shown.
documentCaption	Optional document title to be shown in the window caption. Empty string by default.
duplicateDocument	True: A copy of the document is shown. False: The document is shown. This means that when you close the document window the document is also deleted. This optional parameter is true by default.
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.

ShowNotification()

void ShowNotification	(	string	message,
		ToolTipIcon	toolTipIcon
	)

Shows a notification as (balloon) tip in the taskbar notification area (at the right of the Windows™ taskbar).

Parameters

message	The message to show.
toolTipIcon	The tool tip icon indicating the type of the message (error, warning, info, none). The ToolTipIcon.Info should be used if a simulation finished successfully, ToolTipIcon.None is reserved for future intermediate messages (e.g. "50 % of the simulation done", "switched propagation method" and so on).