parameters: (self)
return_statement: return xstr
docstring: Prints out the supplementary information about a particular input class.
  
        Used to print out the dimensions, default value, possible options and data
        type of an input value to the LaTeX helf file.
docstring_summary: Prints out the supplementary information about a particular input class.
docstring_tokens: Prints out the supplementary information about a particular input class .
function: def detail_str(self):
        """Prints out the supplementary information about a particular input class.
  
        Used to print out the dimensions, default value, possible options and data
        type of an input value to the LaTeX helf file.
        """
  
        xstr = ""
        if hasattr(self, '_dimension') and self._dimension != "undefined": #gives dimension
           xstr += "dimension: " + self._dimension + "; "
  
        if self._default != None and issubclass(self.__class__, InputAttribute):
           #We only print out the default if it has a well defined value.
           #For classes such as InputCell, self._default is not the value,
           #instead it is an object that is stored to give the default value in
           #self.value. For this reason we print out self.value at this stage,
           #and not self._default
           xstr += "default: " + self.pprint(self.value) + "; "
  
        if issubclass(self.__class__, InputAttribute):
           #if possible, prints out the type of data that is being used
           xstr += "data type: " + self.type_print(self.type) + "; "
  
        if hasattr(self, "_valid"):
           if self._valid is not None:
              xstr += "options: " #prints out valid options, if
              for option in self._valid:      #required.
                 xstr += "`" + str(option) + "', "
              xstr = xstr.rstrip(", ")
              xstr +=  "; "
        return xstr
function_tokens: def detail_str ( self ) : xstr = "" if hasattr ( self , '_dimension' ) and self . _dimension != "undefined" : #gives dimension xstr += "dimension: " + self . _dimension + "; " if self . _default != None and issubclass ( self . __class__ , InputAttribute ) : #We only print out the default if it has a well defined value. #For classes such as InputCell, self._default is not the value, #instead it is an object that is stored to give the default value in #self.value. For this reason we print out self.value at this stage, #and not self._default xstr += "default: " + self . pprint ( self . value ) + "; " if issubclass ( self . __class__ , InputAttribute ) : #if possible, prints out the type of data that is being used xstr += "data type: " + self . type_print ( self . type ) + "; " if hasattr ( self , "_valid" ) : if self . _valid is not None : xstr += "options: " #prints out valid options, if for option in self . _valid : #required. xstr += "`" + str ( option ) + "', " xstr = xstr . rstrip ( ", " ) xstr += "; " return xstr