ControlFoldMirror

class ControlFoldMirror(KPFTranslatorFunction):
    '''Insert or remove the FIU Cal Fold Mirror from the beam.

    Args:
        destination (str): The desired FIU fold mirror position name. Allowed
            values: in, out
        wait (bool): Wait for move to complete before returning? (default: True)

    KTL Keywords Used:

    - `kpffiu.FOLDNAM`
    '''
    @classmethod
    def pre_condition(cls, args, logger, cfg):
        destination = args.get('destination', '').strip()
        if destination.lower() not in ['in', 'out']:
            raise FailedPreCondition(f"Requested state {destination} is invalid")

    @classmethod
    def perform(cls, args, logger, cfg):
        destination = args.get('destination', '').strip()
        kpffiu = ktl.cache('kpffiu')
        kpffiu['FOLDNAM'].write(destination)

    @classmethod
    def post_condition(cls, args, logger, cfg):
        destination = args.get('destination', '').strip()
        timeout = cfg.getfloat('times', 'fiu_fold_mirror_move_time', fallback=5)
        success = ktl.waitFor(f'($kpffiu.foldnam == {destination})', timeout=timeout)
        if success is not True:
            foldnam = ktl.cache('kpffiu', 'FOLDNAM')
            raise FailedToReachDestination(foldnam.read(), destination)

    @classmethod
    def add_cmdline_args(cls, parser, cfg=None):
        parser.add_argument('destination', type=str,
                            choices=['in', 'out'],
                            help='Desired fold mirror position')
        return super().add_cmdline_args(parser, cfg)