baseImpl.h

/*
 * Nominal Device Support v3 (NDS3)
 *
 * Copyright (c) 2015 Cosylab d.d.
 *
 * For more information about the license please refer to the license.txt
 * file included in the distribution.
 */

#ifndef NDSBASEIMPL_H
#define NDSBASEIMPL_H

#include <string>
#include <map>
#include <memory>
#include <array>
#include <set>
#include <mutex>
#include <ostream>
#include "nds3/definitions.h"


namespace nds
{


class NodeImpl;
class PortImpl;
class FactoryBaseImpl;
class LogStreamBufferImpl;
class LogStreamGetterImpl;
class ThreadBaseImpl;

class NDS3_API BaseImpl: public std::enable_shared_from_this<BaseImpl>
{
protected:
    BaseImpl(const std::string& name);

public:
    BaseImpl(const BaseImpl& right) = delete;

    virtual ~BaseImpl();

    void setExternalName(const std::string& externalName);

    virtual std::shared_ptr<PortImpl> getPort();

    const std::string& getComponentName() const;

    void setParent(std::shared_ptr<NodeImpl> pParent, const std::uint32_t parentLevel);

    std::shared_ptr<NodeImpl> getParent() const;

    std::uint32_t getNodeLevel() const;

    const std::string& getFullName() const;

    const std::string& getFullNameFromPort() const;

    const std::string& getFullExternalName() const;

    const std::string& getFullExternalNameFromPort() const;



    timespec getTimestamp() const;

    void setTimestampDelegate(getTimestampPlugin_t timestampDelegate);

    ThreadBaseImpl* runInThread(const std::string& name, threadFunction_t function);

    std::ostream& getLogger(const logLevel_t logLevel);

    bool isLogLevelEnabled(const logLevel_t logLevel) const;

    virtual void setLogLevel(const logLevel_t logLevel);

    void defineCommand(const std::string& command, const std::string& usage, const size_t numParameters, const command_t function);

    virtual void initialize(FactoryBaseImpl& controlSystem);

    virtual void deinitialize();


    virtual std::string buildFullName(const FactoryBaseImpl& controlSystem) const ;
    virtual std::string buildFullNameFromPort(const FactoryBaseImpl& controlSystem) const ;

    virtual std::string buildFullExternalName(const FactoryBaseImpl& controlSystem) const = 0;
    virtual std::string buildFullExternalNameFromPort(const FactoryBaseImpl& controlSystem) const = 0;

protected:
    timespec getLocalTimestamp() const;

    virtual parameters_t commandSetLogLevel(const logLevel_t logLevel, const parameters_t& parameters);

    std::string m_name;

    std::string m_externalName;

    std::uint32_t m_nodeLevel;

    std::weak_ptr<NodeImpl> m_pParent;

    FactoryBaseImpl* m_pFactory;

    getTimestampPlugin_t m_timestampFunction;

    volatile logLevel_t m_logLevel;

    LogStreamGetterImpl* m_logStreamGetter;

    struct commandDefinition_t
    {
        commandDefinition_t(const std::string& command, const std::string& usage, const size_t numParameters, command_t function):
            m_command(command), m_usage(usage), m_numParameters(numParameters), m_function(function)
        {
        }

        std::string m_command;
        std::string m_usage;
        size_t m_numParameters;
        command_t m_function;
    };

    typedef std::list<commandDefinition_t> commands_t;
    commands_t m_commands;

protected:
    std::string m_cachedFullName;
    std::string m_cachedFullNameFromPort;
    std::string m_cachedFullExternalName;
    std::string m_cahcedFullExternalNameFromPort;
};


}










#endif // NDSBASEIMPL_H