lar_content::StreamingAlgorithm Class Reference

StreamingAlgorithm class. More...

#include "StreamingAlgorithm.h"

Inheritance diagram for lar_content::StreamingAlgorithm:

Public Member Functions
	StreamingAlgorithm ()
	Default constructor. More...
virtual	~StreamingAlgorithm ()

Private Types
typedef std::map< std::string, pandora::StringVector >	StreamAlgorithmMap

Private Member Functions
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_outputListName
	The name of the output list. More...
std::string	m_listType
	The type of the input lists (currently only Cluster is supported) More...
pandora::StringVector	m_inputListNames
	The names of the input lists. More...
pandora::StringVector	m_outputListNames
	Names of the output lists if not combining into a single list at the end. More...
StreamAlgorithmMap	m_streamAlgorithmMap
	A map from individual streams to the algorithms that stream should run. More...

Detailed Description

StreamingAlgorithm class.

Definition at line 19 of file StreamingAlgorithm.h.

Member Typedef Documentation

typedef std::map<std::string, pandora::StringVector> lar_content::StreamingAlgorithm::StreamAlgorithmMap

private

Definition at line 30 of file StreamingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::StreamingAlgorithm::StreamingAlgorithm

(

)

Default constructor.

Definition at line 26 of file StreamingAlgorithm.cc.

                                       :
    m_listType{"cluster"}
{
}

lar_content::StreamingAlgorithm::~StreamingAlgorithm ( )

virtual

Definition at line 33 of file StreamingAlgorithm.cc.

{
}

Member Function Documentation

StatusCode lar_content::StreamingAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle )

private

Definition at line 81 of file StreamingAlgorithm.cc.

References m_inputListNames, m_listType, m_outputListName, m_outputListNames, and m_streamAlgorithmMap.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ListType", m_listType));
    std::transform(m_listType.begin(), m_listType.end(), m_listType.begin(), ::tolower);
    if (m_listType != "cluster")
    {
        std::cout << "StreamingAlgorithm::ReadSettings - Error: Only Cluster list type is supported at this time" << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }

    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputListNames", m_inputListNames));
    if (m_inputListNames.empty())
    {
        std::cout << "StreamingAlgorithm::ReadSettings - Error: No input lists found" << std::endl;
        return STATUS_CODE_NOT_FOUND;
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "OutputListName", m_outputListName));
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "OutputListNames", m_outputListNames));
    if ((m_outputListName.empty() && m_outputListNames.empty()) || (!m_outputListName.empty() && !m_outputListNames.empty()))
    {
        std::cout << "StreamingAlgorithm::ReadSettings - Error: You must provide either a single output list name OR a list of output list names"
                  << std::endl;
        return STATUS_CODE_NOT_FOUND;
    }
    if (!m_outputListNames.empty() && m_inputListNames.size() != m_outputListNames.size())
    {
        std::cout << "StreamingAlgorithm::ReadSettings - Error: When providing a list of output lists, there should be a one-to-one "
                  << "correspondence with the list of input lists" << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }

    for (std::string listName : m_inputListNames)
    {
        std::string algStreamName{"Algorithms" + listName};
        if (m_streamAlgorithmMap.find(algStreamName) != m_streamAlgorithmMap.end())
        {
            std::cout << "StreamingAlgorithm::ReadSettings - Error: Duplicate stream name found" << std::endl;
            return STATUS_CODE_INVALID_PARAMETER;
        }
        PANDORA_RETURN_RESULT_IF(
            STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmList(*this, xmlHandle, algStreamName, m_streamAlgorithmMap[algStreamName]));
        if (m_streamAlgorithmMap.at(algStreamName).empty())
        {
            std::cout << "StreamingAlgorithm::ReadSettings - Error: Found no algorithms for \'" << algStreamName << "\'" << std::endl;
            return STATUS_CODE_NOT_FOUND;
        }
    }

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::StreamingAlgorithm::Run ( )

private

Definition at line 39 of file StreamingAlgorithm.cc.

References m_inputListNames, m_outputListName, m_outputListNames, and m_streamAlgorithmMap.

{
    unsigned int i{0};
    for (std::string listName : m_inputListNames)
    {
        std::string algStreamName{"Algorithms" + listName};
        const ClusterList *pClusterList{nullptr};
        // Set the input list as current
        PandoraContentApi::ReplaceCurrentList<Cluster>(*this, listName);
        StatusCode code{PandoraContentApi::GetCurrentList(*this, pClusterList)};
        if (code == STATUS_CODE_SUCCESS)
        {
            for (const auto &alg : m_streamAlgorithmMap.at(algStreamName))
            { // ATTN - The algorithms replace the current list as they go
                PandoraContentApi::GetCurrentList(*this, pClusterList);
                if (!pClusterList->empty())
                {
                    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RunDaughterAlgorithm(*this, alg));
                }
            }
            // Save the current list to the target output list
            if (!m_outputListName.empty())
                PandoraContentApi::SaveList<Cluster>(*this, m_outputListName);
            else
                PandoraContentApi::SaveList<Cluster>(*this, m_outputListNames.at(i));
        }
        else if (code != STATUS_CODE_NOT_INITIALIZED)
        {
            return code;
        }
        ++i;
    }

    // If we have a single output list specified, set that list as the current list
    if (!m_outputListName.empty())
        PandoraContentApi::ReplaceCurrentList<Cluster>(*this, m_outputListName);

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::StreamingAlgorithm::m_inputListNames

private

The names of the input lists.

Definition at line 36 of file StreamingAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::StreamingAlgorithm::m_listType

private

The type of the input lists (currently only Cluster is supported)

Definition at line 35 of file StreamingAlgorithm.h.

Referenced by ReadSettings().

std::string lar_content::StreamingAlgorithm::m_outputListName

private

The name of the output list.

Definition at line 34 of file StreamingAlgorithm.h.

Referenced by ReadSettings(), and Run().

pandora::StringVector lar_content::StreamingAlgorithm::m_outputListNames

private

Names of the output lists if not combining into a single list at the end.

Definition at line 37 of file StreamingAlgorithm.h.

Referenced by ReadSettings(), and Run().

StreamAlgorithmMap lar_content::StreamingAlgorithm::m_streamAlgorithmMap

private

A map from individual streams to the algorithms that stream should run.

Definition at line 38 of file StreamingAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

The documentation for this class was generated from the following files:

• larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/StreamingAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/StreamingAlgorithm.cc