KFbxUserNotificationFILE Class Reference

#include <kfbxusernotification.h>

Inherits KFbxUserNotification.

Inheritance diagram for KFbxUserNotificationFILE:

List of all members.

---

Detailed Description

This class sends accumulated messages to a file handler specified by a string.

If the string argument is "StdOut" or "StdErr" (case insensitive), the standard C stdout/stderr devices are used. Similarly, "cout" and "cerr" can be used for standard out/error. Otherwise, the string argument is assumed to be a full filename and is used to open a text file for write. This class does not creates a log file by default.

Definition at line 403 of file kfbxusernotification.h.

Public Member Functions
virtual void	OpenExtraDevices ()
	Allow the implementation class to opens its output devices (called by InitAccumulator).
virtual bool	SendToExtraDevices (bool pOutputNow, KArrayTemplate< AccumulatorEntry * > &pEntries)
	Allow the implementation class to send all the accumulator entries to the devices.
virtual bool	SendToExtraDevices (bool pOutputNow, const AccumulatorEntry *pAccEntry, int pDetailId=-1)
	Allow the implementation class to send one accumulator entry to the devices.
virtual void	CloseExtraDevices ()
	Allow the implementation class to close it's output devices (called in the ClearAccumulator) By default this method does nothing.

---

Member Function Documentation

virtual void OpenExtraDevices

(

)

[virtual]

Allow the implementation class to opens its output devices (called by InitAccumulator).

By default this method does nothing.

Reimplemented from KFbxUserNotification.

virtual bool SendToExtraDevices	(	bool	pOutputNow,
		KArrayTemplate< AccumulatorEntry * > &	pEntries
	)			[virtual]

Allow the implementation class to send all the accumulator entries to the devices.

By default this method loop trough all the elements of the received array and call the SendToExtraDevices method with the appropriate AccumulatorEntry element and id.

Returns:

true if successful, false otherwise.

Reimplemented from KFbxUserNotification.

virtual bool SendToExtraDevices	(	bool	pOutputNow,
		const AccumulatorEntry *	pAccEntry,
		int	pDetailId = -1
	)			[virtual]

Allow the implementation class to send one accumulator entry to the devices.

By default this method does nothing.

Returns:

true if successful, false otherwise.

Remarks:

Derived methods should check for the IsMuted() state to decide if the accumulator entry should get through or get discaded. See AddDetail for more details.

Reimplemented from KFbxUserNotification.

virtual void CloseExtraDevices

(

)

[virtual]

Allow the implementation class to close it's output devices (called in the ClearAccumulator) By default this method does nothing.

Reimplemented from KFbxUserNotification.