IDataDisplay Interface Reference

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

Public Member Functions
void	LogDetectorResult (string detectorName, List< PhysicalValue > results)
	Writes a list of real-valued physical values into the Detector Results tab. More...
void	LogDetectorResult (string detectorName, List< PhysicalValueBase > results)
	Writes a list of physical values into the Detector Results tab. More...
void	LogError (string message)
	Outputs error message. Output format depends on current program settings. More...
void	LogMessage (string message)
	Writes a message to logging window. Date, time, and line break are included. More...
void	LogString (string str)
	Writes a string to logging window. No line break is added. More...
void	LogWarning (string message)
	Outputs warning message. Output format depends on current program settings. More...
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. More...
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. More...
void	ShowNotification (string message, ToolTipIcon toolTipIcon)
	Shows a notification as (balloon) tip in the taskbar notification area (at the right of the Windows� taskbar. More...

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)

LogError()

void LogError

(

string

message

)

Outputs error message. Output format depends on current program settings.

Parameters

message

Error message (string does not have to contain the word "error") to log in logging window of main window of VirtualLab

LogMessage()

void LogMessage

(

string

message

)

Writes a message to logging window. Date, time, and line break are included.

Parameters

message

Message to log in logging window of main window of VirtualLab

LogString()

void LogString

(

string

str

)

Writes a string to logging window. No line break is added.

Parameters

str	String to log in logging window of main window of VirtualLab

LogWarning()

void LogWarning

(

string

message

)

Outputs warning message. Output format depends on current program settings.

Parameters

message

Warning message (string does not have to contain the word "warning") to log in logging window of main window of VirtualLab

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.

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).