opentxs::OTNumList Class Reference

#include <OTNumList.hpp>

Public Member Functions
EXPORT	OTNumList (const std::set< int64_t > &theNumbers)
EXPORT	OTNumList (const OTString &strNumbers)
EXPORT	OTNumList (const std::string &strNumbers)
EXPORT	OTNumList (int64_t lInput)
EXPORT	OTNumList ()
EXPORT	~OTNumList ()
EXPORT bool	Add (const OTString &strNumbers)
EXPORT bool	Add (const std::string &strNumbers)
EXPORT bool	Add (const int64_t &theValue)
EXPORT bool	Remove (const int64_t &theValue)
EXPORT bool	Verify (const int64_t &theValue) const
EXPORT bool	Add (const OTNumList &theNumList)
EXPORT bool	Add (const std::set< int64_t > &theNumbers)
EXPORT bool	Remove (const std::set< int64_t > &theNumbers)
EXPORT bool	Verify (const std::set< int64_t > &theNumbers) const
EXPORT bool	Verify (const OTNumList &rhs) const
EXPORT bool	VerifyAny (const OTNumList &rhs) const
EXPORT bool	VerifyAny (const std::set< int64_t > &setData) const
EXPORT int32_t	Count () const
EXPORT bool	Peek (int64_t &lPeek) const
EXPORT bool	Pop ()
EXPORT bool	Output (std::set< int64_t > &theOutput) const
EXPORT bool	Output (OTString &strOutput) const
EXPORT void	Release ()

Detailed Description

Definition at line 156 of file OTNumList.hpp.

Constructor & Destructor Documentation

opentxs::OTNumList::OTNumList

(

const std::set< int64_t > &

theNumbers

)

Definition at line 148 of file OTNumList.cpp.

{
    Add(theNumbers);
}

opentxs::OTNumList::OTNumList

(

const OTString &

strNumbers

)

Definition at line 164 of file OTNumList.cpp.

{
    Add(strNumbers);
}

opentxs::OTNumList::OTNumList

(

const std::string &

strNumbers

)

Definition at line 169 of file OTNumList.cpp.

{
    Add(strNumbers);
}

opentxs::OTNumList::OTNumList

(

int64_t

lInput

)

Definition at line 153 of file OTNumList.cpp.

{
    Add(lInput);
}

opentxs::OTNumList::OTNumList

(

)

Definition at line 174 of file OTNumList.cpp.

{
}

opentxs::OTNumList::~OTNumList

(

)

Definition at line 178 of file OTNumList.cpp.

{
}

Member Function Documentation

bool opentxs::OTNumList::Add

(

const OTString &

strNumbers

)

Definition at line 182 of file OTNumList.cpp.

{
    return Add(strNumbers.Get());
}

bool opentxs::OTNumList::Add

(

const std::string &

strNumbers

)

Definition at line 189 of file OTNumList.cpp.

{
    return Add(strNumbers.c_str());
}

bool opentxs::OTNumList::Add

(

const int64_t &

theValue

)

Definition at line 272 of file OTNumList.cpp.

{
    auto it = m_setData.find(theValue);

    if (m_setData.end() == it) // it's not already there, so add it.
    {
        m_setData.insert(theValue);
        return true;
    }
    return false; // it was already there.
}

bool opentxs::OTNumList::Add

(

const OTNumList &

theNumList

)

Definition at line 386 of file OTNumList.cpp.

{
    std::set<int64_t> theOutput;
    theNumList.Output(theOutput); // returns false if the numlist was empty.

    return Add(theOutput);
}

bool opentxs::OTNumList::Add

(

const std::set< int64_t > &

theNumbers

)

Definition at line 396 of file OTNumList.cpp.

{
    bool bSuccess = true;

    for (const auto& it : theNumbers) {
        if (!Add(it)) // It must have already been there.
            bSuccess = false;
    }

    return bSuccess;
}

int32_t opentxs::OTNumList::Count

(

)

const

Definition at line 460 of file OTNumList.cpp.

{
    return static_cast<int32_t>(m_setData.size());
}

bool opentxs::OTNumList::Output

(

std::set< int64_t > &

theOutput

)

const

Definition at line 430 of file OTNumList.cpp.

{
    theOutput = m_setData;

    return !m_setData.empty();
}

bool opentxs::OTNumList::Output

(

OTString &

strOutput

)

const

Definition at line 441 of file OTNumList.cpp.

{
    int32_t nIterationCount = 0;

    for (auto& it : m_setData) {
        nIterationCount++;

        strOutput.Concatenate(
            "%s%lld",
            // If first iteration, prepend a blank string (instead of a comma.)
            // Like this:  "%lld"
            // But for all subsequent iterations, concatenate: ",%lld"
            (1 == nIterationCount) ? "" : ",", it);
    }

    return !m_setData.empty();
}

bool opentxs::OTNumList::Peek

(

int64_t &

lPeek

)

const

Definition at line 285 of file OTNumList.cpp.

{
    auto it = m_setData.begin();

    if (m_setData.end() != it) // it's there.
    {
        lPeek = *it;
        return true;
    }
    return false;
}

bool opentxs::OTNumList::Pop

(

)

Definition at line 297 of file OTNumList.cpp.

{
    auto it = m_setData.begin();

    if (m_setData.end() != it) // it's there.
    {
        m_setData.erase(it);
        return true;
    }
    return false;
}

void opentxs::OTNumList::Release

(

)

Definition at line 465 of file OTNumList.cpp.

{
    m_setData.clear();
}

bool opentxs::OTNumList::Remove

(

const int64_t &

theValue

)

Definition at line 309 of file OTNumList.cpp.

{
    auto it = m_setData.find(theValue);

    if (m_setData.end() != it) // it's there.
    {
        m_setData.erase(it);
        return true;
    }
    return false; // it wasn't there (so how could you remove it then?)
}

bool opentxs::OTNumList::Remove

(

const std::set< int64_t > &

theNumbers

)

Definition at line 411 of file OTNumList.cpp.

{
    bool bSuccess = true;

    for (const auto& it : theNumbers) {
        if (!Remove(it)) // It must have NOT already been there.
            bSuccess = false;
    }

    return bSuccess;
}

bool opentxs::OTNumList::Verify

(

const int64_t &

theValue

)

const

Definition at line 322 of file OTNumList.cpp.

{
    auto it = m_setData.find(theValue);

    return (m_setData.end() == it) ? false : true;
}

bool opentxs::OTNumList::Verify

(

const std::set< int64_t > &

theNumbers

)

const

Definition at line 335 of file OTNumList.cpp.

{
    bool bSuccess = true;

    for (const auto& it : theNumbers) {
        if (!Verify(it)) // It must have NOT already been there.
            bSuccess = false;
    }

    return bSuccess;
}

bool opentxs::OTNumList::Verify

(

const OTNumList &

rhs

)

const

True/False, based on whether OTNumLists MATCH in COUNT and CONTENT (NOT ORDER.)

Definition at line 350 of file OTNumList.cpp.

{
    // Verify they have the same number of elements.
    //
    if (Count() != rhs.Count()) return false;

    // Verify each value on *this is also found on rhs.
    //
    for (auto& it : m_setData) {
        if (!rhs.Verify(it)) return false;
    }

    return true;
}

bool opentxs::OTNumList::VerifyAny

(

const OTNumList &

rhs

)

const

True/False, based on whether ANY of the numbers in rhs are found in *this.

Definition at line 367 of file OTNumList.cpp.

{
    return rhs.VerifyAny(m_setData);
}

bool opentxs::OTNumList::VerifyAny

(

const std::set< int64_t > &

setData

)

const

Verify whether ANY of the numbers on *this are found in setData.

Definition at line 374 of file OTNumList.cpp.

{
    for (const auto& it : m_setData) {
        auto it_find = setData.find(it);

        if (it_find != setData.end()) // found a match.
            return true;
    }

    return false;
}

---

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

• /usr/local/src/opentxs/include/opentxs/core/OTNumList.hpp
• /usr/local/src/opentxs/src/core/OTNumList.cpp