IRefTargMonitorClass Class Reference

This reference page is linked to from the following overview topics: Indirect Reference Example.

---

Search for all occurrences

---

Detailed Description

The interface for working with RefTargMonitor class.

The RefTargMonitor class (defined in ctrl.dlc) is used to monitor a RefTarg for its REFMSG_TARGET_DELETED messages. The RefTargMonitor class creates a RefTargMonitorRefMaker instance pointing at a RefTarg, and allows only the REFMSG_TARGET_DELETED message to propagate to the RefTargMonitor's dependents. To prevent circular message loops, the messages are not propagated if that message type is already being propagated.

#include <IRefTargMonitorClass.h>

Inheritance diagram for IRefTargMonitorClass:

List of all members.

Public Types
enum	{ kfpGetRefTarg, kfpSetRefTarg, kfpGetPersist, kfpSetPersist }
Public Member Functions
virtual RefTargetHandle	GetRefTarg ()=0
	Retrieves the RefTarg being watched.
virtual void	SetRefTarg (RefTargetHandle theRefTarg)=0
	Sets the RefTarg being watched.
virtual bool	GetPersist ()=0
	Retrieves whether to force persistence of the target on partial load/save.
virtual void	SetPersist (bool persist)=0
	Sets whether to force persistence of the target on partial load/save.
FPInterfaceDesc *	GetDesc ()
virtual Interface_ID	GetID ()
BEGIN_FUNCTION_MAP	PROP_FNS (kfpGetRefTarg, GetRefTarg, kfpSetRefTarg, SetRefTarg, TYPE_REFTARG)
	PROP_FNS (kfpGetPersist, GetPersist, kfpSetPersist, SetPersist, TYPE_bool)

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

kfpGetRefTarg	Search for all occurrences
kfpSetRefTarg	Search for all occurrences
kfpGetPersist	Search for all occurrences
kfpSetPersist	Search for all occurrences

         {  
        kfpGetRefTarg, kfpSetRefTarg,
        kfpGetPersist, kfpSetPersist,
    };

---

Member Function Documentation

virtual RefTargetHandle GetRefTarg

(

)

[pure virtual]

Search for all occurrences

Retrieves the RefTarg being watched.

Returns:

The RefTarg being watched.

virtual void SetRefTarg

(

RefTargetHandle

theRefTarg

)

[pure virtual]

Search for all occurrences

Sets the RefTarg being watched.

Parameters:

theRefTarg

- The RefTarg to be watched. Can be NULL.

virtual bool GetPersist

(

)

[pure virtual]

Search for all occurrences

Retrieves whether to force persistence of the target on partial load/save.

Returns:

True if force persistence in on.

virtual void SetPersist

(

bool

persist

)

[pure virtual]

Search for all occurrences

Sets whether to force persistence of the target on partial load/save.

Parameters:

persist

- True to force persistence.

FPInterfaceDesc* GetDesc

(

)

[virtual]

Search for all occurrences

Remarks:

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns:

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

{ return IID_REFTARGMONITOR_CLASS; }

BEGIN_FUNCTION_MAP PROP_FNS	(	kfpGetRefTarg	,
		GetRefTarg	,
		kfpSetRefTarg	,
		SetRefTarg	,
		TYPE_REFTARG
	)

Search for all occurrences

PROP_FNS	(	kfpGetPersist	,
		GetPersist	,
		kfpSetPersist	,
		SetPersist	,
		TYPE_bool
	)

Search for all occurrences