Process.h

Go to the documentation of this file.

 
#ifndef PANDORA_PROCESS_H
#define PANDORA_PROCESS_H 1
 
#include "Pandora/StatusCodes.h"
 
#include <string>
 
namespace pandora
{
 
class Pandora;
class TiXmlHandle;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class Process
{
public:
    Process();
 
    const std::string &GetType() const;
 
    const std::string &GetInstanceName() const;
 
    const Pandora &GetPandora() const;
 
protected:
    virtual StatusCode ReadSettings(const TiXmlHandle xmlHandle) = 0;
 
    virtual StatusCode Initialize();
 
    virtual StatusCode Reset();
 
    virtual ~Process();
 
    StatusCode RegisterDetails(const Pandora *const pPandora, const std::string &type, const std::string &instanceName);
 
    const Pandora          *m_pPandora;             
    std::string             m_type;                 
    std::string             m_instanceName;         
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline Process::Process() :
    m_pPandora(nullptr)
{
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const std::string &Process::GetType() const
{
    return m_type;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const std::string &Process::GetInstanceName() const
{
    return m_instanceName;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const Pandora &Process::GetPandora() const
{
    if (!m_pPandora)
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
 
    return *m_pPandora;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline StatusCode Process::Initialize()
{
    return STATUS_CODE_SUCCESS;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline StatusCode Process::Reset()
{
    return STATUS_CODE_SUCCESS;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline Process::~Process()
{
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline StatusCode Process::RegisterDetails(const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
{
    if (!pPandora || type.empty() || instanceName.empty())
        return STATUS_CODE_INVALID_PARAMETER;
 
    if (m_pPandora || !m_type.empty() || !m_instanceName.empty())
        return STATUS_CODE_ALREADY_PRESENT;
 
    m_pPandora = pPandora;
    m_type = type;
    m_instanceName = instanceName;
 
    return STATUS_CODE_SUCCESS;
}
 
} // namespace pandora
 
#endif // #ifndef PANDORA_ALGORITHM_TOOL_H