AccumulatorEntry Class Reference

Search for all occurrences

---

Detailed Description

This class defines one entry object held by the KFbxUserNotification class.

An entry object is a message to show error, warning or information. Direct manipulation of this object should not be required. At most, access to its members can be granted for querying purposes.

Definition at line 39 of file kfbxusernotification.h.

#include <kfbxusernotification.h>

List of all members.

Public Types
enum	AEClass { eAE_ERROR = 1, eAE_WARNING = 2, eAE_INFO = 4, eAE_ANY = 7 }
	Category of the accumulator entry. More...
Public Member Functions
	AccumulatorEntry (AEClass pAEClass, const KString &pName, const KString &pDescr, KString pDetail="", bool pMuteState=true)
	Constructor.
	AccumulatorEntry (const AccumulatorEntry &pAE, bool pSkipDetails)
	Copy Constructor.
	~AccumulatorEntry ()
	Destructor.
AEClass	GetClass () const
	Returns the category class of this entry.
KString	GetName () const
	Returns the name of this entry.
KString	GetDescription () const
	Returns the description of this entry.
int	GetDetailsCount () const
	Returns the number of details stored.
const KString *	GetDetail (int id) const
	Returns a pointer to one specific detail string (or NULL if the id is invalid).
bool	IsMuted () const
	Returns True if this entry is muted.
Friends
class	KFbxUserNotification

---

Member Enumeration Documentation

enum AEClass

Search for all occurrences

Category of the accumulator entry.

Enumerator:

eAE_ERROR	Error message entry. Search for all occurrences
eAE_WARNING	Warning message entry. Search for all occurrences
eAE_INFO	Information message entry. Search for all occurrences
eAE_ANY	Entry that does not belong to above class. Cannot be used as a class ID Search for all occurrences

Definition at line 44 of file kfbxusernotification.h.

                 {
        eAE_ERROR=1,    
        eAE_WARNING=2,  
        eAE_INFO=4,     
        eAE_ANY=7       
    };

---

Constructor & Destructor Documentation

AccumulatorEntry	(	AEClass	pAEClass,
		const KString &	pName,
		const KString &	pDescr,
		KString	pDetail = "",
		bool	pMuteState = true
	)

Constructor.

Parameters:

pAEClass	Specify the category for this entry.
pName	Identifies this entry (more than one object can have the same name).
pDescr	The description of the entry. This is the common message. The details are added separately by the KFbxUserNotification classes.
pDetail	A list of detail string that will be copied into the local array.
pMuteState	Whether this entry is muted.

Remarks:

By default the object is muted so it does not get processed by the low level output routines of the UserNotification accumulator. The entry gets activated (unmuted) by the calls to AddDetail() in the accumulator.

AccumulatorEntry	(	const AccumulatorEntry &	pAE,
		bool	pSkipDetails
	)

Copy Constructor.

Parameters:

pAE	Another AccumulatorEntry object to be copied.
pSkipDetails	Flag to skip details.

~AccumulatorEntry

(

)

Destructor.

---

Member Function Documentation

AEClass GetClass

(

)

const

Search for all occurrences

Returns the category class of this entry.

KString GetName

(

)

const

Search for all occurrences

Returns the name of this entry.

KString GetDescription

(

)

const

Search for all occurrences

Returns the description of this entry.

int GetDetailsCount

(

)

const

Search for all occurrences

Returns the number of details stored.

const KString* GetDetail

(

int

id

)

const

Search for all occurrences

Returns a pointer to one specific detail string (or NULL if the id is invalid).

Detail string is dynamic. One entry can have multiple detail strings to hold extra information. For example, if one entry message is related to many FBX nodes, user can add these nodes' name as details.

Parameters:

id	The detail id.

Returns:

Pointer to the specific detail.

bool IsMuted

(

)

const

Search for all occurrences

Returns True if this entry is muted.

---

Friends And Related Function Documentation

friend class KFbxUserNotification [friend]

Search for all occurrences

Definition at line 98 of file kfbxusernotification.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxplugins/kfbxusernotification.h