INodeMonitor Class Reference
 
 
 
INodeMonitor Class Reference

This reference page is linked to from the following overview topics: Reference System Best Practices, Node Monitors, Indirect Reference Example, Indirect References and Object XRefs.


#include <INodeMonitor.h>

Inheritance diagram for INodeMonitor:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators

Class Description

The interface for working with NodeMonitor class.

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

Public Types

enum   { kfpGetnode, kfpSetnode }

Public Member Functions

virtual INode GetNode ()=0
  Retrieves the node being watched.
virtual void  SetNode (INode *theNode)=0
  Sets the node being watched.
FPInterfaceDesc GetDesc ()
virtual Interface_ID  GetID ()
BEGIN_FUNCTION_MAP  PROP_FNS (kfpGetnode, GetNode, kfpSetnode, SetNode, TYPE_INODE)

Member Enumeration Documentation


Member Function Documentation

virtual INode* GetNode ( ) [pure virtual]

Retrieves the node being watched.

Returns:
INode pointer to the node being watched.
virtual void SetNode ( INode theNode ) [pure virtual]

Sets the node being watched.

Parameters:
theNode - Pointer to node to be watched. Can be NULL.
FPInterfaceDesc* GetDesc ( ) [virtual]
Remarks:
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual Interface_ID GetID ( ) [inline, virtual]
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_NODEMONITOR; }
BEGIN_FUNCTION_MAP PROP_FNS ( kfpGetnode  ,
GetNode  ,
kfpSetnode  ,
SetNode  ,
TYPE_INODE   
)