Source code for cern.pymad.abc.service
#-------------------------------------------------------------------------------
# This file is part of PyMad.
#
# Copyright (c) 2011, CERN. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#-------------------------------------------------------------------------------
'''
Created on 15 Aug 2011
@author: kfuchsbe
'''
from abc import ABCMeta, abstractmethod, abstractproperty
[docs]class PyMadService():
''' The abstract class for a model-service. '''
__metaclass__ = ABCMeta
@abstractproperty
[docs] def mdefs(self):
''' Returns all the available model definitions as a list '''
pass
@abstractproperty
[docs] def mdefnames(self):
''' Returns all the names of the available model definitions '''
pass
@abstractproperty
[docs] def models(self):
''' Returns all the instantiated models as a list '''
pass
@abstractproperty
[docs] def am(self):
''' Returns the active model '''
pass
@abstractmethod
[docs] def create_model(self, modeldef):
"""Create a model instance from a model definition.
Arguments:
modeldef -- the model definition from which to create the model as an
object or just its name. If a name is given, then the modeldefinition
is first searched in the available model definitions.
"""
pass
@abstractmethod
[docs] def delete_model(self, model):
""" cleans up the given model and deletes a model from the available models """
pass
[docs] def cleanup(self):
""" Can be overridden by subclass to do necessary cleanup steps """
pass
