opentxs::OTScript Class Reference

#include <OTScript.hpp>

Collaboration diagram for opentxs::OTScript:

Public Member Functions
	OTScript ()
	OTScript (const OTString &strValue)
	OTScript (const char *new_string)
	OTScript (const char *new_string, size_t sizeLength)
	OTScript (const std::string &new_string)
virtual	~OTScript ()
EXPORT void	SetScript (const OTString &strValue)
EXPORT void	SetScript (const char *new_string)
EXPORT void	SetScript (const char *new_string, size_t sizeLength)
EXPORT void	SetScript (const std::string &new_string)
void	SetDisplayFilename (std::string str_display_filename)
void	AddParty (std::string str_party_name, OTParty &theParty)
void	AddAccount (std::string str_acct_name, OTPartyAccount &theAcct)
EXPORT void	AddVariable (std::string str_var_name, OTVariable &theVar)
EXPORT OTVariable *	FindVariable (std::string str_var_name)
EXPORT void	RemoveVariable (OTVariable &theVar)
virtual bool	ExecuteScript (OTVariable *pReturnVar=nullptr)

Protected Attributes
std::string	m_str_script
std::string	m_str_display_filename
mapOfParties	m_mapParties
mapOfPartyAccounts	m_mapAccounts
mapOfVariables	m_mapVariables

Detailed Description

Definition at line 174 of file OTScript.hpp.

Constructor & Destructor Documentation

opentxs::OTScript::OTScript

(

)

Definition at line 275 of file OTScript.cpp.

{
}

opentxs::OTScript::OTScript

(

const OTString &

strValue

)

Definition at line 279 of file OTScript.cpp.

    : m_str_script(strValue.Get())
{
}

opentxs::OTScript::OTScript

(

const char *

new_string

)

Definition at line 284 of file OTScript.cpp.

    : m_str_script(new_string)
{
}

opentxs::OTScript::OTScript	(	const char *	new_string,
		size_t	sizeLength
	)

Definition at line 289 of file OTScript.cpp.

    : m_str_script(new_string, sizeLength)
{
}

opentxs::OTScript::OTScript

(

const std::string &

new_string

)

Definition at line 294 of file OTScript.cpp.

    : m_str_script(new_string)
{
}

opentxs::OTScript::~OTScript ( )

virtual

Definition at line 299 of file OTScript.cpp.

{
    // mapOfParties; // NO NEED to clean this up, since OTScript doesn't own the
    // parties.
    // See OTSmartContract, rather, for that.

    while (!m_mapVariables.empty()) {
        OTVariable* pVar = m_mapVariables.begin()->second;
        OT_ASSERT(nullptr != pVar);

        // NOTE: We're NOT going to delete pVar, since we don't own it.
        // But we ARE going to remove pVar's pointer to this script, so
        // pVar doesn't dereference a bad pointer later on.
        //
        pVar->UnregisterScript();
        m_mapVariables.erase(m_mapVariables.begin());
    }
}

Member Function Documentation

void opentxs::OTScript::AddAccount	(	std::string	str_acct_name,
		OTPartyAccount &	theAcct
	)

Definition at line 363 of file OTScript.cpp.

{
    m_mapAccounts.insert(
        std::pair<std::string, OTPartyAccount*>(str_acct_name, &theAcct));

    // We're just storing these pointers for reference value. Script doesn't
    // actually Own the
    // accounts, and isn't responsible to clean them up.
}

void opentxs::OTScript::AddParty	(	std::string	str_party_name,
		OTParty &	theParty
	)

Definition at line 350 of file OTScript.cpp.

{
    //  typedef std::map<std::string, OTParty *> mapOfParties;

    m_mapParties.insert(
        std::pair<std::string, OTParty*>(str_party_name, &theParty));
    // We're just storing these pointers for reference value. Script doesn't
    // actually Own the
    // parties, and isn't responsible to clean them up.

    theParty.RegisterAccountsForExecution(*this);
}

void opentxs::OTScript::AddVariable	(	std::string	str_var_name,
		OTVariable &	theVar
	)

Definition at line 380 of file OTScript.cpp.

{
    //  mapOfVariables  m_mapVariables;

    m_mapVariables.insert(
        std::pair<std::string, OTVariable*>(str_var_name, &theVar));

    // We're just storing these pointers for reference value. Script doesn't
    // actually Own the
    // variables, and isn't responsible to clean them up.
}

bool opentxs::OTScript::ExecuteScript ( OTVariable *  pReturnVar = nullptr )

virtual

Definition at line 416 of file OTScript.cpp.

{
    otErr << "OTScript::ExecuteScript: Scripting has been disabled.\n";
    return true;
}

OTVariable * opentxs::OTScript::FindVariable

(

std::string

str_var_name

)

Definition at line 392 of file OTScript.cpp.

{
    auto it_var = m_mapVariables.find(str_var_name);
    return it_var != m_mapVariables.end() ? it_var->second : nullptr;
}

void opentxs::OTScript::RemoveVariable

(

OTVariable &

theVar

)

Definition at line 405 of file OTScript.cpp.

{
    const std::string str_var_name = theVar.GetName().Get();
    auto it_var = m_mapVariables.find(str_var_name);

    if (it_var != m_mapVariables.end()) {
        m_mapVariables.erase(it_var); // no need to delete the variable pointer
                                      // since the script doesn't own it anyway.
    }
}

void opentxs::OTScript::SetDisplayFilename ( std::string  str_display_filename )

inline

Definition at line 204 of file OTScript.hpp.

    {
        m_str_display_filename = str_display_filename;
    }

void opentxs::OTScript::SetScript

(

const OTString &

strValue

)

Definition at line 318 of file OTScript.cpp.

{
    if (strValue.Exists()) m_str_script = strValue.Get();
}

void opentxs::OTScript::SetScript

(

const char *

new_string

)

Definition at line 323 of file OTScript.cpp.

{
    if (nullptr != new_string) m_str_script = new_string;
}

void opentxs::OTScript::SetScript	(	const char *	new_string,
		size_t	sizeLength
	)

Definition at line 328 of file OTScript.cpp.

{
    if (nullptr != new_string) m_str_script.assign(new_string, sizeLength);
}

void opentxs::OTScript::SetScript

(

const std::string &

new_string

)

Definition at line 333 of file OTScript.cpp.

{
    m_str_script = new_string;
}

Member Data Documentation

mapOfPartyAccounts opentxs::OTScript::m_mapAccounts

protected

Definition at line 182 of file OTScript.hpp.

mapOfParties opentxs::OTScript::m_mapParties

protected

Definition at line 180 of file OTScript.hpp.

mapOfVariables opentxs::OTScript::m_mapVariables

protected

Definition at line 185 of file OTScript.hpp.

std::string opentxs::OTScript::m_str_display_filename

protected

Definition at line 178 of file OTScript.hpp.

std::string opentxs::OTScript::m_str_script

protected

Definition at line 177 of file OTScript.hpp.

---

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

• /usr/local/src/opentxs/include/opentxs/core/script/OTScript.hpp
• /usr/local/src/opentxs/src/core/script/OTScript.cpp