Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.vtype.RecordType Class Reference
Inheritance diagram for cpc.dataflow.vtype.RecordType:
cpc.dataflow.vtype.Type cpc.dataflow.description.Describable cpc.dataflow.function_io.IOType

Public Member Functions

def hasMembers
 
def iterMembers
 
def iterMemberKeys
 
def getMemberKeys
 
def getMember
 
def getRecordMember
 
def copyMembers
 
def hasMember
 
def addMember
 
def addDescription
 
def getMemberDesc
 
def setMemberDesc
 
def jsonDescribe
 
def writePartsXML
 
def getSubItem
 
def containsBasetype
 
- Public Member Functions inherited from cpc.dataflow.vtype.Type
def getName
 
def isAnonymous
 
def isBuiltin
 
def getParent
 
def hasMembers
 
def getMembers
 
def isCompound
 
def valueFromLiteral
 
def valueToLiteral
 
def isSubtype
 
def remove
 
def getLib
 
def setLib
 
def getFullName
 
def inherit
 
def writeXML
 
def writePartsXML
 
def getSubItem
 
def getBaseType
 
def getBaseTypeName
 
def jsonDescribe
 
def containsBasetype
 
def isImplicit
 
def markImplicit
 
- Public Member Functions inherited from cpc.dataflow.description.Describable
def setDescription
 
def getDescription
 

Public Attributes

 compound
 
 recordMembers
 
- Public Attributes inherited from cpc.dataflow.vtype.Type
 name
 
 parent
 
 compound
 
 lib
 
 implicit
 
 builtin
 
 simpleLiteral
 
- Public Attributes inherited from cpc.dataflow.description.Describable
 desc
 

Detailed Description

Base class describing a named list with fixed membership.

Member Function Documentation

def cpc.dataflow.vtype.RecordType.addDescription (   self,
  name,
  desc 
)
Add a description of a member to the record
def cpc.dataflow.vtype.RecordType.addMember (   self,
  name,
  vtype,
  opt,
  const,
  complete 
)
Add/override a new member to the record.
   name = the name of the new member item
   vtype = the type of the new member item
   opt = whether the member is optional
   const = hwehter the member is const
   complete = whether the member's subvalues must be non-None
def cpc.dataflow.vtype.RecordType.containsBasetype (   self,
  basetype 
)
Check whether the type or one of its members contains an instance
   of basetype.
def cpc.dataflow.vtype.RecordType.copyMembers (   self,
  recordType 
)
Set the members of the record according to a another record type.
def cpc.dataflow.vtype.RecordType.getMember (   self,
  name 
)
Get a specific member type.
def cpc.dataflow.vtype.RecordType.getMemberDesc (   self,
  name 
)
Get a specific member description.
def cpc.dataflow.vtype.RecordType.getMemberKeys (   self)
Get a list with the member keys of the record.
def cpc.dataflow.vtype.RecordType.getRecordMember (   self,
  name 
)
Get a specific RecordMember object
def cpc.dataflow.vtype.RecordType.getSubItem (   self,
  item 
)
Get a specific sub-item.
def cpc.dataflow.vtype.RecordType.hasMember (   self,
  name 
)
Return whether the member with name 'name' exists.
def cpc.dataflow.vtype.RecordType.hasMembers (   self)
Returns whether the type has member variables
def cpc.dataflow.vtype.RecordType.iterMemberKeys (   self)
Generate an iterable list of the names of members
def cpc.dataflow.vtype.RecordType.iterMembers (   self)
Generate an iterable list of tuples: (key, member)
def cpc.dataflow.vtype.RecordType.jsonDescribe (   self)
Get a description of a type in a JSON-serializable format.
def cpc.dataflow.vtype.RecordType.setMemberDesc (   self,
  name,
  desc 
)
Get a specific member description.
def cpc.dataflow.vtype.RecordType.writePartsXML (   self,
  outf,
  indent = 0 
)
Write the xml of the constituent parts of the type for compound
    types.

Member Data Documentation

cpc.dataflow.vtype.RecordType.compound
cpc.dataflow.vtype.RecordType.recordMembers

The documentation for this class was generated from the following file: