KnowledgeInterfaces Interface CATIParmEvents

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

interface CATIParmEvents

Interface dedicated to parameters events management.
Role: This interface is used to add subscription to parameters events.
It is implemented on parameters. 4 events are available

  • ChangeValue when content is actually changed
  • Rename when parameter is actually renamed
  • ChangeVisu when
  • for internal reasons :
  • visibility change
  • user access change
  • driving relation set or unset
  • magnitude current unit change
  • for external reason : (SendChangeVisu)
  • driving relation is activated or desactivated
  • Delete when literal is deleted (before deletion)
    • This interface is multi implemented. It is implemented on literal and volatile values
    See also:
    ,

    Method Index


    o DefineSendBehavior(SendBehavior)
    Sets the way the Change value event is sent.
    o GetChangeValueNotification()
    Returns change value notification.
    o GetChangeVisuNotification()
    Returns change visu notification.
    o GetDeleteNotification()
    Returns delete notification.
    o GetRenameNotification()
    Returns rename notification.
    o SendChangeValueNotification(CATCke::Boolean&)
    Produces the change value event dispatch on the parameter.
    o SendChangeVisuNotification()
    Produces the change visu event dispatch on the parameter.

    Enumerated Type Index


    o SendBehavior
    Defines when Change value event is dispatched by parameter.

    Methods


    o DefineSendBehavior
    public virtual DefineSendBehavior( const iSendBehavior)
    Sets the way the Change value event is sent.
    Parameters:
    iSendBehavior
    : change value event mode
    o GetChangeValueNotification
    public virtual GetChangeValueNotification()
    Returns change value notification.
    o GetChangeVisuNotification
    public virtual GetChangeVisuNotification()
    Returns change visu notification.
    o GetDeleteNotification
    public virtual GetDeleteNotification()
    Returns delete notification.
    o GetRenameNotification
    public virtual GetRenameNotification()
    Returns rename notification.
    o SendChangeValueNotification
    public virtual SendChangeValueNotification( const iChanged= 1)
    Produces the change value event dispatch on the parameter.
    Parameters:
    iChanged
    : indicates if value has actually changed
    .
    o SendChangeVisuNotification
    public virtual SendChangeVisuNotification()
    Produces the change visu event dispatch on the parameter.

    Enumerated Types


    o SendBehavior 
    enum SendBehavior {
  Never,
  WhenChanged,
  WhenValuated
}
    Defines when Change value event is dispatched by parameter.
    Never = change value event is never sent.
    WhenChanged = when valuated and value is eventually changed.
    WhenValuated = when valuated even if value isn't changed.
    This object is included in the file: CATIParmEvents.h
    If needed, your Imakefile.mk should include the module: KnowledgeItf

    Copyright © 1999-2015, Dassault Systèmes. All rights reserved.