cmnObjectRegister.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):  Andy LaMora, Anton Deguet
  Created on: 2004-05-11

  (C) Copyright 2004-2007 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 _cmnObjectRegister_h
#define _cmnObjectRegister_h

#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnClassRegister.h>

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

#include <cisstCommon/cmnExport.h>


class CISST_EXPORT cmnObjectRegister {

    typedef std::map<std::string, cmnGenericObject *> ContainerType;
    typedef ContainerType::iterator iterator;
    typedef ContainerType::reverse_iterator reverse_iterator;

public:
    typedef ContainerType::const_iterator const_iterator;
    typedef ContainerType::const_reverse_iterator const_reverse_iterator;

private:

    ContainerType ObjectContainer;


    bool RegisterInstance(const std::string & objectName,
                          cmnGenericObject * objectPointer);


    bool RemoveInstance(const std::string & objectName);


    cmnGenericObject* FindObjectInstance(const std::string & objectName) const;


    std::string FindNameInstance(cmnGenericObject * objectPointer) const;


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

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

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

protected:
    cmnObjectRegister() {};

    virtual ~cmnObjectRegister() {};

 public:

    static cmnObjectRegister * Instance(void);


    static inline bool Register(const std::string & objectName,
                                cmnGenericObject * objectPointer) {
        return Instance()->RegisterInstance(objectName, objectPointer);
    }


    static inline bool Remove(const std::string & objectName) {
        return Instance()->RemoveInstance(objectName);
    }


    static inline cmnGenericObject * FindObject(const std::string & objectName) {
        return Instance()->FindObjectInstance(objectName);
    }


    static inline std::string FindName(cmnGenericObject * objectPointer) {
        return Instance()->FindNameInstance(objectPointer);
    }


    static std::string ToString(void) {
        std::stringstream outputStream;
        ToStream(outputStream);
        return outputStream.str();
    }


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


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


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

};


#endif // _cmnObjectRegister_h