GlobalReferenceMaker Class Reference

This reference page is linked to from the following overview topics: Schematic View Window, Schematic View Events.

---

Search for all occurrences

---

Detailed Description

This class lets you tap in to ALL reference messages in the entire system.

Once registered, the NotifyRefChanged() method will be called once for every time NotifyRefChanged() is called on a regular ReferenceTarget effectively allowing you to wire tap the entire reference network.
WARNING This should be used with extreme care. NotifyRefChange() will be called MANY MANY times so it is important to do very little processing within this method. This most that should probably be done is to set a dirty bit.

#include <ref.h>

Inheritance diagram for GlobalReferenceMaker:

List of all members.

Classes
class	GlobalReferenceDisableGuard
	This class is used to temporarily disable global reference makers. More...
Public Member Functions
virtual	~GlobalReferenceMaker ()
virtual RefResult	NotifyRefChanged (Interval iv, RefTargetHandle hTarg, PartID &partID, RefMessage msg)=0
	Callback function to receive messages.

---

Constructor & Destructor Documentation

virtual ~GlobalReferenceMaker

(

)

[inline, virtual]

{}

---

Member Function Documentation

virtual RefResult NotifyRefChanged	(	Interval	iv,
		RefTargetHandle	hTarg,
		PartID &	partID,
		RefMessage	msg
	)		[pure virtual]

Search for all occurrences

Callback function to receive messages.

This method is implemented to receive and respond to messages broadcast by all the Dependants in the entire system.

Parameters:

iv	- This is the interval of time over which the message is active. Currently, all plugins will receive FOREVER for this interval.
hTarg	- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID	- This contains information specific to the message passed in. Some messages don't use the partID at all.
msg	- The msg parameters passed into this method is the specific message which needs to be handled.

Returns:

The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.