IRsPhysObjEvent Interface Reference

Inherits IUnknown.

List of all members.

Public Member Functions
HRESULT	AddEvent ([in] RtPhysEvent event,[in] IRsNode *source,[in] IRsNode *peer)
HRESULT	RemEvent ([in] RtPhysEvent event,[in] IRsNode *source,[in] IRsNode *peer)
HRESULT	CountEvent ([out] RtUlong *count)
HRESULT	GetEvent ([in] RtUlong index,[out] RtPhysEvent *event,[out] IRsNode **source,[out] IRsNode **peer)
HRESULT	ClearEvent ()

---

Detailed Description

IRsPhysObjEvent interface methods that manage sending phys events

---

Member Function Documentation

HRESULT IRsPhysObjEvent::AddEvent	(	[in] RtPhysEvent	event,
		[in] IRsNode *	source,
		[in] IRsNode *	peer
	)

Add phys event.

Parameters:

	event	[in] Event IRsPhysObjEvent::RtPhysEvent.
	source	[in] Source node.
	peer	[in] Peer node when in interaction, can be NULL.

HRESULT IRsPhysObjEvent::RemEvent	(	[in] RtPhysEvent	event,
		[in] IRsNode *	source,
		[in] IRsNode *	peer
	)

Remove phys event.

Parameters:

	event	[in] Event IRsPhysObjEvent::RtPhysEvent.
	source	[in] Source node.
	peer	[in] Peer object if event monitors interaction between two objects, can be NULL.

HRESULT IRsPhysObjEvent::CountEvent

(

[out] RtUlong *

count

)

Count phys event.

Parameters:

count

[out] Number of stored events.

HRESULT IRsPhysObjEvent::GetEvent	(	[in] RtUlong	index,
		[out] RtPhysEvent *	event,
		[out] IRsNode **	source,
		[out] IRsNode **	peer
	)

Return phys event.

Parameters:

	index	[in] Position of event.
	event	[out] Event IRsPhysObjEvent::RtPhysEvent.
	source	[out] Event's source.
	peer	[out] Peer object if event monitors interaction between two objects.

HRESULT IRsPhysObjEvent::ClearEvent

(

)

Remove all phys events.