m2mdevice.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019 ARM Limited. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 * 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.
 */
#ifndef M2M_DEVICE_H
#define M2M_DEVICE_H

#include "mbed-client/m2mobject.h"

// FORWARD DECLARATION
class M2MResource;
class M2MResourceInstance;

class  M2MDevice : public M2MObject {

friend class M2MInterfaceFactory;

public:

    typedef enum {
        Manufacturer,
        DeviceType,
        ModelNumber,
        SerialNumber,
        HardwareVersion,
        FirmwareVersion,
        SoftwareVersion,
        Reboot,
        FactoryReset,
        AvailablePowerSources,
        PowerSourceVoltage,
        PowerSourceCurrent,
        BatteryLevel,
        BatteryStatus,
        MemoryFree,
        MemoryTotal,
        ErrorCode,
        ResetErrorCode,
        CurrentTime,
        UTCOffset,
        Timezone,
        SupportedBindingMode
    }DeviceResource;

private:

    M2MDevice(char *path);

    // Prevents the use of assignment operator.
    M2MDevice& operator=( const M2MDevice& /*other*/ );

    // Prevents the use of copy constructor
    M2MDevice( const M2MDevice& /*other*/ );

    virtual ~M2MDevice();

    static M2MDevice* get_instance();

public:

    static void delete_instance();

    M2MResource* create_resource(DeviceResource resource, const String &value);

    M2MResource* create_resource(DeviceResource resource, int64_t value);

    M2MResourceInstance* create_resource_instance(DeviceResource resource, int64_t value,
                                                  uint16_t instance_id);

    M2MResource* create_resource(DeviceResource resource);

    bool delete_resource(DeviceResource resource);

    bool delete_resource_instance(DeviceResource resource,
                                  uint16_t instance_id);

    bool set_resource_value(DeviceResource resource,
                            const String &value,
                            uint16_t instance_id = 0);

    bool set_resource_value(DeviceResource resource,
                            int64_t value,
                            uint16_t instance_id = 0);

    String resource_value_string(DeviceResource resource,
                                 uint16_t instance_id = 0) const;

    int64_t resource_value_int(DeviceResource resource,
                               uint16_t instance_id = 0) const;

    bool is_resource_present(DeviceResource resource)const;

    uint16_t total_resource_count()const;

    uint16_t per_resource_count(DeviceResource resource)const;

private:

    M2MResourceBase* get_resource_instance(DeviceResource dev_res,
                                               uint16_t instance_id) const;

    static const char* resource_name(DeviceResource resource);

    static bool check_value_range(DeviceResource resource, const int64_t value);

private :

    M2MObjectInstance*    _device_instance;     //Not owned

protected:

    static M2MDevice*     _instance;

    friend class Test_M2MDevice;
    friend class Test_M2MInterfaceFactory;
};

#endif // M2M_DEVICE_H