All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIEventManager

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ENOVIEventManager
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIEventManager

Interface to manage Event Model (subscription, information about events).
Role:
This class managers all the actions around the Enovia Event Model:
-Subscription/Unsubscription to/from events by clients.
-information about subscribers, raised events.
-information about the events clients can subscribe to


Method Index


o AddSubscriptionFilter(unsigned long,CATUnicodeString&,CATUnicodeString&,CORBAAny&)
Adds a filter to a given subscription referred to by its cookie.
o GetEventsRaised(ENOVIPublisher_var&,CATLISTV(CATBaseUnknown_var)&)
Gets all the events raised by a given publisher during the session.
o GetListOfRaisableEvents(CATUnicodeString&,CATBaseUnknown_var&,CATListOfCATUnicodeString&)
Gives the list of events a type of object can raise.
o GetListOfRaisableEvents(ENOVIPublisher_var&,CATBaseUnknown_var&,CATListOfCATUnicodeString&)
Gives the list of events a publisher instance can raise.
o GetRaisedEvents(CATLISTV(CATBaseUnknown_var)&)
Gets the events raised during the session.
o GetRaisedEvents(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Gets the events of a given name raised during the session.
o GetRaisedEvents(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Gets the event of a given name raised by a type of object during the session.
o GetRaisedEvents(CATUnicodeString&,ENOVIPublisher_var&,CATLISTV(CATBaseUnknown_var)&)
Gets the events of a given name raised by a given publisher during the session.
o GetRaisedEventsOnType(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Gets all the events raised by a given type of object during the session.
o Subscribe(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown_var&,IID&,unsigned long*,ENOVIEvent::VPMEventFireMode&,int&,VPM_Boolean)
Subscribes to an event on a given type of object.
o Subscribe(CATUnicodeString&,CATUnicodeString&,ENOVISubscriberEvent_var&,unsigned long*,ENOVIEvent::VPMEventFireMode&,int&,VPM_Boolean)
Subscribes to an event on a given type of object.
o Subscribe(CATUnicodeString&,ENOVIPublisher_var&,CATBaseUnknown_var&,IID&,unsigned long*,ENOVIEvent::VPMEventFireMode&,int&,VPM_Boolean)
Subscribes to an event for a given instance.
o Subscribe(CATUnicodeString&,ENOVIPublisher_var&,ENOVISubscriberEvent_var&,unsigned long*,ENOVIEvent::VPMEventFireMode&,int&,VPM_Boolean)
Subscribes to an event on a given instance.
o Unsubscribe(unsigned long)
Unsubscribes a client.

Methods


o AddSubscriptionFilter
public virtual HRESULT AddSubscriptionFilter(unsigned long iCookie,
const CATUnicodeString& iCategory,
const CATUnicodeString& iName,
const CORBAAny& iValue)=0
Adds a filter to a given subscription referred to by its cookie.
Role : Allow to more precisely determine events you are interested in
Parameters:
iCookie
given by the event manager to identify a subscription
iCategory
the category of the filter: either "ON_EVENT" or "ON_PUBLISHER". ON_EVENT filters allow to select events according to their associated
ENOVIStream. ON_PUBLISHER filters allow to select events according to a condition on the object that published them. This condition can be built from an existing extended data group.
iName
the name of the filter. For ON_EVENT filters, iName refers to the name of the argument of the
ENOVIStream. For ON_PUBLISHER filters, it refers to the condition name (whatsoever or existing data group).
iValue
the value of the filter. For ON_EVENT filters, iValue refers to the value of the argument of the
ENOVIStream. For ON_PUBLISHER filters, it refers to the condition value itself (a character string).
o GetEventsRaised
public virtual HRESULT GetEventsRaised( const ENOVIPublisher_var& iPublisher,
CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets all the events raised by a given publisher during the session.
Parameters:
iPublisher
The publisher instance
oListOfRaisedEvents
the list of events raised since the beginning.
o GetListOfRaisableEvents
public virtual HRESULT GetListOfRaisableEvents( const CATUnicodeString& iPublisherType,
const CATBaseUnknown_var& iSubscriber,
CATListOfCATUnicodeString& oAvailableEvents)=0
Gives the list of events a type of object can raise.
Role : According to the nature of the subscriber, gives back the list of events it can subscribe to.
Parameters:
iPublisherType
string giving the type of publisher
iSubscriber
the client instance which wants to subscribe.
oAvailableEvents
the list of events which may be raised by the publisher type.
o GetListOfRaisableEvents
public virtual HRESULT GetListOfRaisableEvents( const ENOVIPublisher_var& iPublisherinstance,
const CATBaseUnknown_var& iSubscriber,
CATListOfCATUnicodeString& oAvailableEvents)=0
Gives the list of events a publisher instance can raise.
Role : According to the nature of the subscriber, gives back the list of events it can subscribe to,
Parameters:
iPublisherinstance
a publisher instance
iSubscriber
the client instance which wants to subscribe.
oAvailableEvents
the list of events which may be raised by the publisher type.
o GetRaisedEvents
public virtual HRESULT GetRaisedEvents(CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets the events raised during the session.
Parameters:
oListOfRaisedEvents
the list of events raised since the beginning.
o GetRaisedEvents
public virtual HRESULT GetRaisedEvents( const CATUnicodeString& iEventName,
CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets the events of a given name raised during the session.
Parameters:
iEventName
name of the wanted event
oListOfRaisedEvents
the list of events raised since the beginning.
o GetRaisedEvents
public virtual HRESULT GetRaisedEvents( const CATUnicodeString& iEventName,
const CATUnicodeString& iObjectType,
CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets the event of a given name raised by a type of object during the session.
Parameters:
iEventName
name of the wanted event
iObjectType
type of the object wanted
oListOfRaisedEvents
the list of events raised since the beginning.
o GetRaisedEvents
public virtual HRESULT GetRaisedEvents( const CATUnicodeString& iEventName,
const ENOVIPublisher_var& iPublisher,
CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets the events of a given name raised by a given publisher during the session.
Parameters:
iEventName
name of the wanted event
iPublisher
The publisher instance
oListOfRaisedEvents
the list of events raised since the beginning.
o GetRaisedEventsOnType
public virtual HRESULT GetRaisedEventsOnType( const CATUnicodeString& iObjectType,
CATLISTV(CATBaseUnknown_var)& oListOfRaisedEvents) =0
Gets all the events raised by a given type of object during the session.
Parameters:
iObjectType
type of the object wanted
oListOfRaisedEvents
the list of events raised since the beginning.
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iMethodName,
const CATUnicodeString& iObjectType,
const CATBaseUnknown_var& iCallBackInterface,
const IID& iIDOfInterface,
unsigned long* oSubscriberCookie,
const ENOVIEvent::VPMEventFireMode& iFireMode= ENOVIEvent::EventFireStandard,
const int& iPriority= 5,
VPM_Boolean WithPersistency=bFalse)=0
Subscribes to an event on a given type of object.
Role : subscribe in EARLY mode, i.e. by implementing an explicit CallBack interface, delivered by the publisher side.
Parameters:
iMethodName
event name you want to subscribe to.
iObjectType
object type you want to subscribe to.
iCallBackInterface
interface for the callback methods, implemented by the client which subscribes.
iIDOfInterface
Real ID of iCallBackInterface
oSubscriberCookie
given by the event manager. to be kept to unsubscribe with.
iFireMode
step you want to subscribe to (before/after or both).
iPriority
priority of subscription. from 1 to 9 - standard = 5.
WithPersistency
flag to store a persistent subscription. not used.
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iMethodName,
const CATUnicodeString& iObjectType,
const ENOVISubscriberEvent_var& iCallBackInterface,
unsigned long* oSubscriberCookie,
const ENOVIEvent::VPMEventFireMode& iFireMode= ENOVIEvent::EventFireStandard,
const int& iPriority= 5,
VPM_Boolean WithPersistency=bFalse)=0
Subscribes to an event on a given type of object.
Role : subscribe in LATE mode, i.e. by implementing a unique standard interface ENOVISubscriberEvent
Parameters:
iMethodName
event name you want to subscribe to.
iObjectType
object type you want to subscribe to.
iCallBackInterface
an implementation of the standard callback interface ENOVISubscriberEvent
oSubscriberCookie
given by the event manager. to be kept to unsubscribe with.
iFireMode
step you want to subscribe to (before/after or both).By default both.
iPriority
priority of subscription. from 1 to 9 - standard = 5.
WithPersistency
flag to store a persistent subscription. not used.
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iMethodName,
const ENOVIPublisher_var& iObjectInstance,
const CATBaseUnknown_var& iCallBackInterface,
const IID& iIDOfInterface,
unsigned long* oSubscriberCookie,
const ENOVIEvent::VPMEventFireMode& iFireMode= ENOVIEvent::EventFireStandard ,
const int& iPriority= 5,
VPM_Boolean WithPersistency=bFalse)=0
Subscribes to an event for a given instance.
Role : subscribe in EARLY mode, i.e. by implementing an explicit CallBack interface, delivered by the publisher side.
Parameters:
iMethodName
event name you want to subscribe to.
iObjectInstance
object type you want to subscribe to.
iCallBackInterface
interface for the callback methods, implemented by the client which subscribes.
iIDOfInterface
Real ID of iCallBackInterface
oSubscriberCookie
given by the event manager. to be kept to unsubscribe with.
iFireMode
step you want to subscribe to (before/after or both).
iPriority
priority of subscription. from 1 to 9 - standard = 5.
WithPersistency
flag to store a persistent subscription. not used.
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iMethodName,
const ENOVIPublisher_var& iObjectInstance,
const ENOVISubscriberEvent_var& iCallBackInterface,
unsigned long* oSubscriberCookie,
const ENOVIEvent::VPMEventFireMode& iFireMode= ENOVIEvent::EventFireStandard ,
const int& iPriority= 5,
VPM_Boolean WithPersistency=bFalse)=0
Subscribes to an event on a given instance.
Role : subscribe in LATE mode, i.e. by implementing a unique standard interface ENOVISubscriberEvent
Parameters:
iMethodName
event name you want to subscribe to.
iObjectInstance
the object instance you want to subscribe to.
iCallBackInterface
an implementation of the standard callback interface ENOVISubscriberEvent
oSubscriberCookie
given by the event manager. to be kept to unsubscribe with.
iFireMode
step you want to subscribe to (before/after or both).By default both.
iPriority
priority of subscription. from 1 to 9 - standard = 5.
WithPersistency
flag to store a persistent subscription. not used.
o Unsubscribe
public virtual HRESULT Unsubscribe(unsigned long iCookie)=0
Unsubscribes a client.
Role : unsubscription using the cookie given at subscription time.
Parameters:
iCookie
the cookie given at subscription time

This object is included in the file: ENOVIEventManager.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.