cmnClassRegister.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):  Alvin Liem, Anton Deguet
  Created on: 2002-08-01

  (C) Copyright 2002-2010 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 _cmnClassRegister_h
#define _cmnClassRegister_h

#include <cisstCommon/cmnPortability.h>
#include <cisstCommon/cmnForwardDeclarations.h>
#include <cisstCommon/cmnLogger.h>

#include <iostream>
#include <sstream>
#include <string>
#include <map>
#include <typeinfo>
#include <fstream>

#include <cisstCommon/cmnExport.h>


class CISST_EXPORT cmnClassRegister {
 public:
    typedef std::map<std::string, cmnClassServicesBase*> ServicesContainerType;
    typedef ServicesContainerType::value_type EntryType;

    typedef ServicesContainerType::const_iterator const_iterator;
    typedef ServicesContainerType::const_reverse_iterator const_reverse_iterator;

    typedef ServicesContainerType::size_type size_type;

 private:
    typedef ServicesContainerType::iterator iterator;
    typedef ServicesContainerType::reverse_iterator reverse_iterator;

    ServicesContainerType ServicesContainer;

 public:
    cmnClassServicesBase * FindClassServicesInstance(const std::string & className);

    cmnClassServicesBase * FindClassServicesInstance(const std::type_info & typeInfo);

    const std::string *
    RegisterInstance(cmnClassServicesBase * classServicesPointer,
                     const std::string & className);

    bool SetLogMaskClassAllInstance(cmnLogMask mask);

    bool SetLogMaskClassMatchingInstance(const std::string & stringToMatch, cmnLogMask mask);

    std::string ToStringInstance(void) const;

    void ToStreamInstance(std::ostream & outputStream) const;

    inline size_type sizeInstance(void) const {
        return ServicesContainer.size();
    }

    inline const_iterator beginInstance(void) const {
        return ServicesContainer.begin();
    }

    inline const_iterator endInstance(void) const {
        return ServicesContainer.end();
    }

protected:
    inline cmnClassRegister(void) {};

 public:

    static cmnClassRegister * Instance(void);


    static inline const std::string *
    Register(cmnClassServicesBase * classServicesPointer,
             const std::string & className)
    {
        return Instance()->RegisterInstance(classServicesPointer,
                                            className);
    }


    static bool SetLogMaskClass(const std::string & className, cmnLogMask mask);

    static inline bool CISST_DEPRECATED SetLoD(const std::string & className, cmnLogMask mask) {
        return SetLogMaskClass(className, mask);
    }


    static inline bool SetLogMaskClassAll(cmnLogMask mask) {
        return Instance()->SetLogMaskClassAllInstance(mask);
    }

    static inline bool CISST_DEPRECATED SetLoDForAllClasses(cmnLogMask mask) {
        return SetLogMaskClassAll(mask);
    }


    static inline bool SetLogMaskClassMatching(const std::string & stringToMatch, cmnLogMask mask) {
        return Instance()->SetLogMaskClassMatchingInstance(stringToMatch, mask);
    }

    static inline bool CISST_DEPRECATED SetLoDForMatchingClasses(const std::string & stringToMatch, cmnLogMask mask) {
        return Instance()->SetLogMaskClassMatching(stringToMatch, mask);
    }


    static inline cmnClassServicesBase * FindClassServices(const std::string & className) {
        return Instance()->FindClassServicesInstance(className);
    }

    static inline cmnClassServicesBase * FindClassServices(const std::type_info & typeInfo) {
        return Instance()->FindClassServicesInstance(typeInfo);
    }


    static cmnGenericObject * Create(const std::string & className);

    static cmnGenericObject * Create(const std::string & className,
                                     const cmnGenericObject & other);


    static std::string ToString(void);


    static void ToStream(std::ostream & outputStream) {
        Instance()->ToStreamInstance(outputStream);
    }


    static size_type size(void) {
        return Instance()->sizeInstance();
    }

    static const_iterator begin(void) {
        return Instance()->beginInstance();
    }


    static const_iterator end(void) {
        return Instance()->endInstance();
    }

};


inline
std::ostream & operator << (std::ostream & output,
                            const cmnClassRegister & classRegister) {
    classRegister.ToStream(output);
    return output;
}


#endif // _cmnClassRegister_h