cmnClassServicesBase.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Anton Deguet, Peter Kazanzides
  Created on: 2004-08-18

  (C) Copyright 2004-2012 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---

*/


#pragma once

#ifndef _cmnClassServicesBase_h
#define _cmnClassServicesBase_h

#include <cisstCommon/cmnForwardDeclarations.h>
#include <cisstCommon/cmnLogLoD.h>

#include <string>
#include <typeinfo>

#include <cisstCommon/cmnExport.h>

class CISST_EXPORT cmnClassServicesBase
{
 public:
    typedef cmnGenericObject * generic_pointer;

    cmnClassServicesBase(const std::string & className,
                         const std::type_info * typeInfo,
                         const cmnClassServicesBase * parentServices,
                         const std::string & libraryName,
                         cmnLogMask mask = CMN_LOG_ALLOW_DEFAULT);


    virtual ~cmnClassServicesBase() {}


    virtual cmnGenericObject * Create(void) const = 0;

    virtual cmnGenericObject * Create(const cmnGenericObject & other) const = 0;

    virtual cmnGenericObject * CreateWithArg(const cmnGenericObject & arg) const = 0;

    virtual bool Create(cmnGenericObject * existing, const cmnGenericObject & other) const = 0;

    virtual cmnGenericObject * CreateArray(size_t size) const = 0;

    virtual cmnGenericObject * CreateArray(size_t size,
                                           const cmnGenericObject & other) const = 0;

    virtual bool DeleteArray(generic_pointer & data, size_t & size) const = 0;

    virtual bool Delete(cmnGenericObject * existing) const = 0;

    virtual size_t GetSize(void) const = 0;

    virtual bool HasDynamicCreation(void) const = 0;

    virtual bool DefaultConstructorAvailable(void) const = 0;
    virtual bool CopyConstructorAvailable(void) const = 0;
    virtual bool OneArgConstructorAvailable(void) const = 0;

    virtual const cmnClassServicesBase *GetConstructorArgServices(void) const = 0;

    const std::string & GetName(void) const;

    const std::type_info * TypeInfoPointer(void) const;

    const cmnLogMask & GetLogMask(void) const;

    inline const cmnLogMask & GetLoD(void) const {
        return GetLogMask();
    }


    void SetLogMask(cmnLogMask mask);

    inline void CISST_DEPRECATED SetLoD(cmnLogMask mask) {
        SetLogMask(mask);
    }

    const cmnClassServicesBase * GetParentServices(void) const {
        return ParentServices;
    }

    bool IsDerivedFrom(const cmnClassServicesBase *parentServices) const;

    template <class _Parent>
    bool IsDerivedFrom(void) const {
        return IsDerivedFrom(_Parent::ClassServices());
    }

    const std::string & GetLibraryName(void) const;

private:
    const std::string * NameMember;

    const std::type_info * TypeInfoMember;

    const cmnClassServicesBase * ParentServices;

    const std::string LibraryName;

    cmnLogMask LogMask;
};



template <class _class>
cmnClassServicesBase * cmnClassServicesInstantiate(void);


#endif // _cmnClassServicesBase_h