device.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.13 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _DEVICE_H_
#define _DEVICE_H_

// ************************************************************************
// included header files
// + standard includes

// + libraries

// + local headers
#include "osbid.h"
#include "osbtype.h"

// + class declarations
namespace OSB_DB {
    class DeviceGw;
    class Session;
}

namespace OSB_LIB {
    class InventoryPool;
    class PersDevice;
}

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// ************************************************************************
// forward declarations

// ************************************************************************
// type definitions

// ************************************************************************
// class definitions
    class Device {
        friend class OSB_DB::DeviceGw;
        friend class PersDevice;
    public:
        typedef TypeId<Device> Type;
        typedef Id<Device> Oid;
        typedef Id<InventoryPool> PoolId;

        enum Status {
            dvcUnknown = '\0',
            dvcCreated    = 'c',
            dvcAvailable  = 'v',
            dvcAssigned   = 'a',
            dvcDeactivated = 'd'
        };

    public:
        explicit Device(const Oid& oid = Oid());
        virtual ~Device();
    protected:
        Device(const Device& rhs);
        Device& operator=(const Device& rhs);

    public:
        Oid oid() const;
        virtual Type type() const = 0;
        Status status() const;
        PoolId poolId() const;

        void setPool(
            const PoolId poolId
        );
        virtual void setStatus(
            const Status newStatus
        );

    public:
        static void lock(
            const OSB_DB::Session& session,
            const Oid&             id,
                  bool             noWait
        );

        void lock(
            const OSB_DB::Session& session,
                  bool             noWait
        ) const;



        virtual void read(
            const OSB_DB::Session& session
        ) = 0;
        virtual void saveData(
            const OSB_DB::Session& session,
                  bool             noWait
        ) = 0;
        virtual void updStatus(
            const OSB_DB::Session& session,
                  bool             noWait
        );
        virtual void remove(
            const OSB_DB::Session& session,
                  bool             noWait
        ) = 0;

    protected:
        static void handleObjectStatus(
                  ObjectStatus os,
            const Oid&         id
        );



        void readBase(
            const OSB_DB::Session& session
        );
        void insertBase(
            const OSB_DB::Session& session
        );
        void updDataBase(
            const OSB_DB::Session& session,
                  bool             noWait
        );
        void removeBase(
            const OSB_DB::Session& session
        );
        void incObjVs(const OSB_DB::Session& session);

    private:                            // for PersDevice only
        void setAssigned(
            const OSB_DB::Session& session
        );
        void setUnAssigned(
            const OSB_DB::Session& session
        );
        void setDeassigned(
            const OSB_DB::Session& session
        );
    private:
        void updStatusNoLock(
            const OSB_DB::Session& session
        );
    private:
        Oid oid_;
        long objVs_;
        Status status_;
        PoolId poolId_;
    };                                  // class Device
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _DEVICE_H_

---