gensrc.enumerations.enumerationlist.EnumerationList Class Reference
Inheritance diagram for gensrc.enumerations.enumerationlist.EnumerationList:
Collaboration diagram for gensrc.enumerations.enumerationlist.EnumerationList:

Public Member Functions

def enumeratedTypeCopyright (self)
 public interface More...
 
def enumeratedClassCopyright (self)
 
def enumeratedPairCopyright (self)
 
def enumeratedTypeGroupsCount (self)
 
def enumeratedClassGroupsCount (self)
 
def enumeratedTypeGroups (self)
 
def enumeratedClassGroups (self)
 
def enumeratedPairGroups (self)
 
def __init__ (self)
 private member functions More...
 
def enumIncludes (self, parameterList)
 

Public Attributes

 typeDict_
 
 hasEnumeratedTypes
 
 hasEnumeratedClasses
 
 hasEnumeratedPairs
 

Detailed Description

Encapsulate a list of enumerated types, classes, and pairs.

Constructor & Destructor Documentation

◆ __init__()

def gensrc.enumerations.enumerationlist.EnumerationList.__init__ (   self)

private member functions

Initialize the EnumerationList object and load enumeration parameters from
available config files.

Member Function Documentation

◆ enumeratedClassCopyright()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedClassCopyright (   self)
Return the copyright message for enumerated classes.

◆ enumeratedClassGroups()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedClassGroups (   self)
Serve up enumerated class objects alphabetically by name.

◆ enumeratedClassGroupsCount()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedClassGroupsCount (   self)
Return the number of enumerated classes.

◆ enumeratedPairCopyright()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedPairCopyright (   self)
Return the copyright message for enumerated pairs.

◆ enumeratedPairGroups()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedPairGroups (   self)
Serve up enumerated pair objects alphabetically by name.

◆ enumeratedTypeCopyright()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedTypeCopyright (   self)

public interface

Return the copyright message for enumerated types.

◆ enumeratedTypeGroups()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedTypeGroups (   self)
Serve up enumerated type objects alphabetically by name.

◆ enumeratedTypeGroupsCount()

def gensrc.enumerations.enumerationlist.EnumerationList.enumeratedTypeGroupsCount (   self)
Return the number of enumerated types.

◆ enumIncludes()

def gensrc.enumerations.enumerationlist.EnumerationList.enumIncludes (   self,
  parameterList 
)
Generate a list of all the #includes necessary to compile source code
for any enumerations which may appear in the given parameter list.

The documentation for this class was generated from the following file:
  • enumerationlist.py