Gestionnaire d’événements

Faits rapides

Propriété	Valeur
Classe	`CENPyOlpEventHandler`
Module	`cenpylib.CENPyOlpEventHandler`
Paquet	`cenpylib`
Libération	R2025.2.4
Méthodes	9

Départ rapide


# Boilerplate Example
# Acquire the event object from the runtime context
eventHandler = ...  # provided by the framework

Index de la méthode

Méthode	Retours	Résumé
`GetEventsByName`	`list[CENPyOlpEventObject]`	Obtenez tous les événements OLP existants avec le nom spécifié sur l’élément de parcours d’outil donné.
`GetRuleBasedEventsByName`	`list[CENPyOlpEventObject]`	Obtenez tous les événements OLP basés sur des règles existants avec le nom spécifié sur l’élément de parcours d’outil donné.
`GetBuiltInEventsByType`	`list`	Obtenez tous les événements intégrés existants avec le type spécifié sur l’élément de parcours d’outil donné.
`GetAllRuleBasedEvents`	`list`	Obtenez tous les événements OLP basés sur des règles existants sur l’élément de parcours d’outil donné.
`GetAllNonRuleBasedEvents`	`list`	Obtenez tous les événements OLP existants, non ajoutés par une règle, sur l’élément de parcours d’outil donné.
`AddEventByName`	`CENPyOlpEventObject`	Ajouter un nouvel événement OLP sur l’élément de parcours d’outil donné.
`AddBuiltInEventByType`	`Any`	Ajoutez un nouvel événement intégré sur l’élément de parcours d’outil donné.
`RemoveEvent`	`—`	Supprimez l’événement OLP donné de l’élément de trajectoire d’outil spécifié.
`RemoveBuiltInEvent`	`—`	Supprimer l’événement intégré de l’élément de parcours d’outil donné.

Méthodes de requête

`GetEventsByName`


def GetEventsByName(tpElement: CENPyOlpTpElement, eventName: str) -> list[CENPyOlpEventObject]

Obtenez tous les événements OLP existants avec le nom spécifié sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour vérifier les événements.
`eventName`	`str`	Nom d’événement à rechercher.

Retours : list[CENPyOlpEventObject] — Liste des objets CENPyOlpEventObject, événements trouvés.

`GetRuleBasedEventsByName`


def GetRuleBasedEventsByName(tpElement: CENPyOlpTpElement, eventName: str) -> list[CENPyOlpEventObject]

Obtenez tous les événements OLP basés sur des règles existants avec le nom spécifié sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour vérifier les événements.
`eventName`	`str`	Nom d’événement à rechercher.

Retours : list[CENPyOlpEventObject] — Liste des objets CENPyOlpEventObject, événements trouvés.

`GetBuiltInEventsByType`


def GetBuiltInEventsByType(tpElement: CENPyOlpTpElement, iEventType: int) -> list

Obtenez tous les événements intégrés existants avec le type spécifié sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour vérifier les événements
`iEventType`	`int`	Type d’événement à rechercher.

Retours : list — Liste des objets, événements trouvés.

`GetAllRuleBasedEvents`


def GetAllRuleBasedEvents(tpElement: CENPyOlpTpElement) -> list

Obtenez tous les événements OLP basés sur des règles existants sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour vérifier les événements.

Retours : list — Nombre d’événements trouvés.

`GetAllNonRuleBasedEvents`


def GetAllNonRuleBasedEvents(tpElement: CENPyOlpTpElement) -> list

Obtenez tous les événements OLP existants, non ajoutés par une règle, sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour vérifier les événements.

Retours : list — Nombre d’événements trouvés.

Méthodes de mutation

`AddEventByName`


def AddEventByName(tpElement: CENPyOlpTpElement, eventName: str, iInsertPosition: int) -> CENPyOlpEventObject

Ajouter un nouvel événement OLP sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil sur lequel ajouter un nouvel événement.
`eventName`	`str`	Nom de l’événement à ajouter.
`iInsertPosition`	`int`	Insérez la position. « Hériter » n’est pas pris en charge car il n’y a pas d’événement parent.

Retour : CENPyOlpEventObject — Événement nouvellement ajouté.

`AddBuiltInEventByType`


def AddBuiltInEventByType(tpElement: CENPyOlpTpElement, iEventType: int, iInsertPosition: int) -> object

Ajoutez un nouvel événement intégré sur l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil sur lequel ajouter un nouvel événement.
`iEventType`	`int`	Type d’événement à ajouter.
`iInsertPosition`	`int`	Insérez la position. « Hériter » n’est pas pris en charge car il n’y a pas d’événement parent.

Retour : Any — Événement nouvellement ajouté.

`RemoveEvent`


def RemoveEvent(tpElement: CENPyOlpTpElement, event: CENPyOlpEventObject)

Supprimez l’événement OLP donné de l’élément de trajectoire d’outil spécifié.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour retirer un événement.
`event`	`CENPyOlpEventObject`	Événement à retirer.

`RemoveBuiltInEvent`


def RemoveBuiltInEvent(tpElement: CENPyOlpTpElement, event: object)

Supprimer l’événement intégré de l’élément de parcours d’outil donné.

Paramètres :

Nom	Type	Description
`tpElement`	`CENPyOlpTpElement`	Élément de parcours d’outil pour retirer un événement.
`event`	`Any`	Événement intégré à supprimer.

Types apparentés

Notes de la version

Cette classe est documentée à la version R2025.2.4.

Was this page helpful?