Phoenix Logo

phoenix_title wx.lib.pubsub.core.topicargspec.ArgSpecGiven

The message data specification (MDS) for a topic. This consists of each argument name that listener should have in its call protocol, plus which ones are required in any sendMessage(), and a documentation string for each argument. This instance will be transformed into an ArgsInfo object which is basically a superset of that information, needed to ensure that the arguments specifications satisfy pubsub policies for chosen API version.


class_hierarchy Class Hierarchy

Inheritance diagram for class ArgSpecGiven:

method_summary Methods Summary

__init__  
getOptional  
isComplete Returns True if the definition is usable, false otherwise.
setAll  

api Class API



class ArgSpecGiven

The message data specification (MDS) for a topic. This consists of each argument name that listener should have in its call protocol, plus which ones are required in any sendMessage(), and a documentation string for each argument. This instance will be transformed into an ArgsInfo object which is basically a superset of that information, needed to ensure that the arguments specifications satisfy pubsub policies for chosen API version.


Methods



__init__(self, argsDocs=None, reqdArgs=None)


getOptional(self)


isComplete(self)

Returns True if the definition is usable, false otherwise.



setAll(self, allArgsDocs, reqdArgs = None)