FbxAccumulatorEntry Class Reference

#include <fbxusernotification.h>

Class Description

This class defines one entry object held by the FbxUserNotification 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 34 of file fbxusernotification.h.

Public Types
enum	EClass { eError =1, eWarning =2, eInformation =4, eAny =7 }
	Category of the accumulator entry. More...

Public Member Functions
	FbxAccumulatorEntry (EClass pAEClass, const FbxString &pName, const FbxString &pDescr, FbxString pDetail="", bool pMuteState=true)
	Constructor. More...
	FbxAccumulatorEntry (const FbxAccumulatorEntry &pAE, bool pSkipDetails)
	Copy Constructor. More...
	~FbxAccumulatorEntry ()
	Destructor. More...
EClass	GetClass () const
	Returns the category class of this entry. More...
FbxString	GetName () const
	Returns the name of this entry. More...
FbxString	GetDescription () const
	Returns the description of this entry. More...
int	GetDetailsCount () const
	Returns the number of details stored. More...
const FbxString *	GetDetail (int id) const
	Returns a pointer to one specific detail string (or NULL if the id is invalid). More...
bool	IsMuted () const
	Returns True if this entry is muted. More...

Friends
class	FbxUserNotification

Member Enumeration Documentation

EClass

enum EClass

Category of the accumulator entry.

Enumerator
eError	Error message entry.
eWarning	Warning message entry.
eInformation	Information message entry.
eAny	Entry that does not belong to above class. Cannot be used as a class ID

Definition at line 39 of file fbxusernotification.h.

    {
        eError=1,    
        eWarning=2,  
        eInformation=4,     
        eAny=7       
    };

Constructor & Destructor Documentation

FbxAccumulatorEntry() [1/2]

FbxAccumulatorEntry	(	EClass	pAEClass,
		const FbxString &	pName,
		const FbxString &	pDescr,
		FbxString	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 FbxUserNotification 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.

FbxAccumulatorEntry() [2/2]

FbxAccumulatorEntry	(	const FbxAccumulatorEntry &	pAE,
		bool	pSkipDetails
	)

Copy Constructor.

Parameters

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

~FbxAccumulatorEntry()

~FbxAccumulatorEntry

(

)

Destructor.

Member Function Documentation

GetClass()

EClass GetClass

(

)

const

Returns the category class of this entry.

GetName()

FbxString GetName

(

)

const

Returns the name of this entry.

GetDescription()

FbxString GetDescription

(

)

const

Returns the description of this entry.

GetDetailsCount()

int GetDetailsCount

(

)

const

Returns the number of details stored.

GetDetail()

const FbxString* GetDetail

(

int

id

)

const

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.

IsMuted()

bool IsMuted

(

)

const

Returns True if this entry is muted.

Friends And Related Function Documentation

FbxUserNotification

friend class FbxUserNotification

friend

Definition at line 103 of file fbxusernotification.h.

---

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

• fbxsdk/utils/fbxusernotification.h