Navigation

Phoenix Logo

phoenix_title wx.lib.pubsub.core.topicdefnprovider.ITopicDefnProvider

All topic definition providers added via pub.addTopicDefnProvider() must have this interface. Derived classes must override the getDefn(), getTreeDoc() and topicNames() methods.


class_hierarchy Class Hierarchy

Inheritance diagram for class ITopicDefnProvider:


method_summary Methods Summary

getDefn Must return a pair (string, ArgSpecGiven) for given topic.
getTreeDoc Get the docstring for the topic tree.
topicNames Return an iterator over topic names available from this provider.

api Class API


class ITopicDefnProvider

All topic definition providers added via pub.addTopicDefnProvider() must have this interface. Derived classes must override the getDefn(), getTreeDoc() and topicNames() methods.


Methods


getDefn(self, topicNameTuple)

Must return a pair (string, ArgSpecGiven) for given topic. The first item is a description for topic, the second item contains the message data specification (MDS). Note topic name is in tuple format (‘a’, ‘b’, ‘c’) rather than ‘a.b.c’.


getTreeDoc(self)

Get the docstring for the topic tree.


topicNames(self)

Return an iterator over topic names available from this provider. Note that the topic names should be in tuple rather than dotted-string format so as to be compatible with getDefn().