Class DescriptorGenerator

source code

                   object --+                    
                            |                    
 base.structure.StructureBase --+                
                                |                
                   object --+   |                
                            |   |                
           base.common.Parser --+                
                                |                
base.structure.ParseableStructure --+            
                                    |            
             base.structure.Structure --+        
                                        |        
                           object --+   |        
                                    |   |        
      base.structure.RestrictionMixin --+        
                                        |        
                   rscdef.procdef.ProcDef --+    
                                            |    
                       rscdef.procdef.ProcApp --+
                                                |
                                               DescriptorGenerator

A procedure application for making product descriptors for PUBDIDs

Despite the name, a descriptor generator has to *return* (not yield) a descriptor instance. While this could be anything, it is recommended to derive custom classes from prodocols.datalink.ProductDescrpitor, which exposes essentially the columns from DaCHS' product table as attributes. This is what you get when you don't define a descriptor generator in your datalink core.

The following names are available to the code:

• pubDID -- the pubDID to be resolved
• args -- all the arguments that came in from the web (these should not ususally be necessary for making the descriptor and are completely unparsed at this point)
• FITSProductDescriptor -- the base class of FITS product descriptors
• DLFITSProductDescriptor -- the same, just for when the product table has a datalink.
• ProductDescriptor -- a base class for your own custom descriptors
• DatalinkFault -- use this when flagging failures
• soda -- contents of the soda module for convenience

If you made your pubDID using the ``getStandardPubDID`` rowmaker function, and you need no additional logic within the descriptor, the default (//soda#fromStandardPubDID) should do.

If you need to derive custom descriptor classes, you can see the base class under the name ProductDescriptor; there's also FITSProductDescriptor and DatalinkFault in each proc's namespace. If your Descriptor does not actually refer to something in the product table, it is likely that you want to set the descriptor's ``suppressAutoLinks`` attribute to True. This will stop DaCHS from attempting to add automatic #this and #preview links.