AT_CellularBase.h

00001 /*
00002  * Copyright (c) 2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef AT_CELLULAR_BASE_H_
00018 #define AT_CELLULAR_BASE_H_
00019 
00020 #include "ATHandler.h"
00021 
00022 namespace mbed {
00023 
00024 /**
00025  *  Class AT_CellularBase
00026  *
00027  *  A base class for AT-classes.
00028  */
00029 class AT_CellularBase
00030 {
00031 public:
00032     AT_CellularBase(ATHandler& at);
00033 
00034     /** Getter for at handler. Common method for all AT-classes.
00035      *
00036      *  @return reference to ATHandler
00037      */
00038     ATHandler& get_at_handler();
00039 
00040     /** Gets the device error that happened when using AT commands/responses. This is at error
00041      *  returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.
00042      *
00043      *  @return at error (CME/CMS) while communicating with the device
00044      */
00045     device_err_t get_device_error() const;
00046 
00047 protected:
00048     ATHandler& _at;
00049 };
00050 
00051 } // namespace mbed
00052 
00053 #endif /* AT_CELLULAR_BASE_H_ */