Source code for pipeline.h.cli.h_resume

##################### generated by xml-casa (v2) from h_resume.xml ##################
##################### ebc776e07786ea3062364a70e6062879 ##############################
from __future__ import absolute_import
import numpy
from casatools.typecheck import CasaValidator as _val_ctor
_pc = _val_ctor( )
from casatools.coercetype import coerce as _coerce
from .private.task_h_resume import h_resume as _h_resume_t
from casatasks.private.task_logging import start_log as _start_log
from casatasks.private.task_logging import end_log as _end_log

class _h_resume:
    """
    h_resume ---- Restore a save pipeline state

    h_resume restores a name pipeline state from disk, allowing a
    suspended pipeline reduction session to be resumed.

    --------- parameter descriptions ---------------------------------------------

    filename Name of the saved pipeline state. Setting filename to 'last'
             restores the most recently saved pipeline state whose name
             begins with 'context*'.

    --------- examples -----------------------------------------------------------

    
    1. Resume the last saved session
    
    h_resume()
    
    2. Resume the named saved session
    
    h_resume(filename='context.s3.2012-02-13T10:49:11')


    """

    _info_group_ = """pipeline"""
    _info_desc_ = """Restore a save pipeline state"""

    def __call__( self, filename='last' ):
        schema = {'filename': {'type': 'cStr', 'coerce': _coerce.to_str}}
        doc = {'filename': filename}
        assert _pc.validate(doc,schema), str(_pc.errors)
        _logging_state_ = _start_log( 'h_resume', [ 'filename=' + repr(_pc.document['filename']) ] )
        return _end_log( _logging_state_, 'h_resume', _h_resume_t( _pc.document['filename'] ) )

h_resume = _h_resume( )