base.h

Go to the documentation of this file.

/*
 * 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 NDSBASE_H
#define NDSBASE_H

#include <memory>
#include <string>
#include <ostream>
#include "nds3/definitions.h"
#include "nds3/thread.h"

namespace nds
{

class BaseImpl;
class Port;
class Node;

class NDS3_API Base
{
    friend class Node;

public:
#ifndef SWIG
    Base(std::shared_ptr<BaseImpl> impl);
#endif

protected:
    Base();

public:
    Base(const Base& right);

    Base& operator=(const Base& right);

    virtual ~Base();

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

    virtual Port getPort();

    const std::string& getComponentName() const;

    const std::string& getFullName() const;

    const std::string& getFullExternalName() const;

    const std::string& getFullNameFromPort() const;

    timespec getTimestamp() const;

    void setTimestampDelegate(getTimestampPlugin_t timestampDelegate);

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

    bool isLogLevelEnabled(const logLevel_t logLevel) const;

    void setLogLevel(const logLevel_t logLevel);

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

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

    Thread runInThread(threadFunction_t function);

#ifndef SWIG
protected:
    std::shared_ptr<BaseImpl> m_pImplementation;
#endif

};

}
#endif // NDSBASE_H