#include <BasketContract.hpp>

Inheritance diagram for opentxs::BasketContract:

Collaboration diagram for opentxs::BasketContract:

Public Member Functions
EXPORT	BasketContract (Basket &basket, OTPseudonym &signer)

virtual	~BasketContract ()

virtual void	CreateContents ()

Public Member Functions inherited from opentxs::OTAssetContract
EXPORT	OTAssetContract ()

EXPORT	OTAssetContract (OTString &name, OTString &foldername, OTString &filename, OTString &strID)

virtual EXPORT	~OTAssetContract ()

EXPORT bool	IsShares () const

EXPORT bool	AddAccountRecord (const OTAccount &theAccount) const

EXPORT bool	EraseAccountRecord (const OTIdentifier &theAcctID) const

EXPORT bool	VisitAccountRecords (AccountVisitor &visitor) const

EXPORT bool	FormatAmount (int64_t amount, std::string &str_output) const

EXPORT bool	StringToAmount (int64_t &amount, const std::string &str_input) const

EXPORT const OTString &	GetBasketInfo () const

EXPORT const OTString &	GetCurrencyName () const

EXPORT const OTString &	GetCurrencyFraction () const

EXPORT const OTString &	GetCurrencySymbol () const

EXPORT const OTString &	GetCurrencyTLA () const

virtual EXPORT bool	SaveContractWallet (OTString &strContents) const

virtual EXPORT bool	SaveContractWallet (std::ofstream &ofs) const

virtual EXPORT bool	DisplayStatistics (OTString &strContents) const

Public Member Functions inherited from opentxs::OTContract
const char *	GetHashType () const

void	SetIdentifier (const OTIdentifier &theID)

EXPORT	OTContract ()

EXPORT	OTContract (const OTString &name, const OTString &foldername, const OTString &filename, const OTString &strID)

EXPORT	OTContract (const OTString &strID)

EXPORT	OTContract (const OTIdentifier &theID)

void	Initialize ()

virtual EXPORT	~OTContract ()

virtual EXPORT void	Release ()

EXPORT void	Release_Contract ()

EXPORT void	ReleaseSignatures ()

virtual EXPORT bool	CreateContract (const OTString &strContract, const OTPseudonym &theSigner)

EXPORT bool	InsertNym (const OTString &strKeyName, const OTString &strKeyValue)

EXPORT void	GetName (OTString &strName) const

EXPORT void	SetName (const OTString &strName)

virtual EXPORT bool	VerifyContract ()

virtual EXPORT void	GetIdentifier (OTIdentifier &theIdentifier) const

virtual EXPORT void	GetIdentifier (OTString &theIdentifier) const

EXPORT void	GetFilename (OTString &strFilename) const

EXPORT void	GetFoldername (OTString &strFoldername) const

virtual EXPORT bool	LoadContract ()

EXPORT bool	LoadContract (const char szFoldername, const char szFilename)

EXPORT bool	LoadContractFromString (const OTString &theStr)

bool	LoadContractRawFile ()

EXPORT bool	ParseRawFile ()

EXPORT bool	SaveToContractFolder ()

EXPORT bool	SaveContractRaw (OTString &strOutput) const

EXPORT bool	RewriteContract (OTString &strOutput) const

EXPORT bool	SaveContract ()

EXPORT bool	SaveContract (const char szFoldername, const char szFilename)

virtual EXPORT void	UpdateContents ()

EXPORT void	CreateInnerContents ()

virtual EXPORT bool	SaveContents (std::ofstream &ofs) const

virtual EXPORT bool	SaveContents (OTString &strContents) const

virtual EXPORT bool	SignContract (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContractAuthent (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignWithKey (const OTAsymmetricKey &theKey, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const OTPseudonym &theNym, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContractAuthent (const OTPseudonym &theNym, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const OTAsymmetricKey &theKey, OTSignature &theSignature, const OTString &strHashType, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const char szFoldername, const char szFilename, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

virtual EXPORT bool	VerifyContractID () const

virtual EXPORT void	CalculateContractID (OTIdentifier &newID) const

virtual EXPORT bool	VerifySignature (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr) const

virtual EXPORT bool	VerifySigAuthent (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifyWithKey (const OTAsymmetricKey &theKey, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const OTPseudonym &theNym, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySigAuthent (const OTPseudonym &theNym, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const OTAsymmetricKey &theKey, const OTSignature &theSignature, const OTString &strHashType, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const char szFoldername, const char szFilename, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT const OTAsymmetricKey *	GetContractPublicKey () const

EXPORT const OTPseudonym *	GetContractPublicNym () const

Protected Member Functions
virtual int32_t	ProcessXMLNode (irr::io::IrrXMLReader *&xml)

Protected Member Functions inherited from opentxs::OTContract
bool	LoadContractXML ()

Additional Inherited Members
Static Public Member Functions inherited from opentxs::OTAssetContract
static EXPORT std::string	formatLongAmount (int64_t lValue, int32_t nFactor=100, int32_t nPower=2, const char szCurrencySymbol="", const char szThousandSeparator=",", const char *szDecimalPoint=".")

static EXPORT bool	ParseFormatted (int64_t &lResult, const std::string &str_input, int32_t nFactor=100, int32_t nPower=2, const char szThousandSeparator=",", const char szDecimalPoint=".")

Static Public Member Functions inherited from opentxs::OTContract
static EXPORT bool	DearmorAndTrim (const OTString &strInput, OTString &strOutput, OTString &strFirstLine)

static bool	AddBookendsAroundContent (OTString &strOutput, const OTString &strContents, const OTString &strContractType, const OTString &strHashType, const listOfSignatures &listSignatures)

static EXPORT bool	LoadEncodedTextField (irr::io::IrrXMLReader *&xml, OTASCIIArmor &ascOutput)

static EXPORT bool	LoadEncodedTextField (irr::io::IrrXMLReader *&xml, OTString &strOutput)

static bool	LoadEncodedTextFieldByName (irr::io::IrrXMLReader &xml, OTASCIIArmor &ascOutput, const char &szName, OTString::Map *pmapExtraVars=nullptr)

static bool	LoadEncodedTextFieldByName (irr::io::IrrXMLReader &xml, OTString &strOutput, const char &szName, OTString::Map *pmapExtraVars=nullptr)

static bool	SkipToElement (irr::io::IrrXMLReader *&xml)

static bool	SkipToTextField (irr::io::IrrXMLReader *&xml)

static bool	SkipAfterLoadingField (irr::io::IrrXMLReader *&xml)

static EXPORT bool	SignFlatText (OTString &strFlatText, const OTString &strContractType, const OTPseudonym &theSigner, OTString &strOutput)

Protected Attributes inherited from opentxs::OTAssetContract
OTString	m_strBasketInfo

OTString	m_strIssueCompany

OTString	m_strIssueEmail

OTString	m_strIssueContractURL

OTString	m_strIssueType

OTString	m_strIssueDate

OTString	m_strCurrencyName

OTString	m_strCurrencyType

OTString	m_strCurrencySymbol

OTString	m_strCurrencyTLA

OTString	m_strCurrencyFactor

OTString	m_strCurrencyDecimalPower

OTString	m_strCurrencyFraction

bool	m_bIsCurrency

bool	m_bIsShares

Protected Attributes inherited from opentxs::OTContract
OTString	m_strName

OTString	m_strFoldername

OTString	m_strFilename

OTIdentifier	m_ID

OTStringXML	m_xmlUnsigned

OTString	m_strRawFile

OTString	m_strSigHashType

OTString	m_strContractType

mapOfNyms	m_mapNyms

listOfSignatures	m_listSignatures

OTString	m_strVersion

OTString	m_strEntityShortName

OTString	m_strEntityLongName

OTString	m_strEntityEmail

OTString::Map	m_mapConditions

Detailed Description

Definition at line 144 of file BasketContract.hpp.

Constructor & Destructor Documentation

opentxs::BasketContract::BasketContract	(	Basket &	basket,
		OTPseudonym &	signer
	)

Definition at line 150 of file BasketContract.cpp.

     : OTAssetContract()
 {
     // Grab a string copy of the basket information.
     theBasket.SaveContractRaw(m_strBasketInfo);
 
     OTString strTemplate;
     OTASCIIArmor theBasketArmor(m_strBasketInfo);
 
     m_xmlUnsigned.Concatenate("<?xml version=\"%s\"?>\n", "1.0");
 
     strTemplate.Concatenate("<basketContract version=\"%s\">\n\n",
                             m_strVersion.Get());
     strTemplate.Concatenate("<basketInfo>\n%s</basketInfo>\n\n",
                             theBasketArmor.Get());
 
     strTemplate.Concatenate("</%s>\n", "basketContract");
 
     CreateContract(strTemplate, theSigner);
 }

opentxs::BasketContract::~BasketContract ( )

virtual

Definition at line 171 of file BasketContract.cpp.

172 {

173 }

Member Function Documentation

void opentxs::BasketContract::CreateContents ( )

virtual

Reimplemented from opentxs::OTAssetContract.

Definition at line 175 of file BasketContract.cpp.

 {
     m_strVersion = "2.0"; // 2.0 since adding credentials.
 
     m_xmlUnsigned.Release();
     m_xmlUnsigned.Concatenate("<?xml version=\"%s\"?>\n", "1.0");
 
     OTASCIIArmor theBasketArmor(m_strBasketInfo);
 
     m_xmlUnsigned.Concatenate("<basketContract version=\"%s\">\n\n",
                               m_strVersion.Get());
     m_xmlUnsigned.Concatenate("<basketInfo>\n%s</basketInfo>\n\n",
                               theBasketArmor.Get());
 
     // This is where OTContract scribes m_xmlUnsigned with its keys, conditions,
     // etc.
     CreateInnerContents();
 
     m_xmlUnsigned.Concatenate("</%s>\n", "basketContract");
 }

int32_t opentxs::BasketContract::ProcessXMLNode ( irr::io::IrrXMLReader *& xml )

protectedvirtual

Reimplemented from opentxs::OTAssetContract.

Definition at line 197 of file BasketContract.cpp.

 {
     int32_t nReturnVal = OTContract::ProcessXMLNode(xml);
 
     // Here we call the parent class first.
     // If the node is found there, or there is some error,
     // then we just return either way.  But if it comes back
     // as '0', then nothing happened, and we'll continue executing.
     //
     // -- Note you can choose not to call the parent if
     // you don't want to use any of those xml tags.
 
     if (nReturnVal == 1 || nReturnVal == (-1)) return nReturnVal;
 
     OTString strNodeName(xml->getNodeName());
 
     if (strNodeName.Compare("basketContract")) {
         m_strVersion = xml->getAttributeValue("version");
 
         otWarn << "\n"
                   "===> Loading XML portion of basket contract into memory "
                   "structures...\n\n"
                   "Digital Basket Contract: " << m_strName
                << "\nContract version: " << m_strVersion << "\n----------\n";
         nReturnVal = 1;
     }
     else if (strNodeName.Compare("basketInfo")) {
         if (!OTContract::LoadEncodedTextField(xml, m_strBasketInfo)) {
             otErr << "Error in OTAssetContract::ProcessXMLNode: basketInfo "
                      "field without value.\n";
             return (-1); // error condition
         }
         nReturnVal = 1;
     }
 
     return nReturnVal;
 }

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

/usr/local/src/opentxs/include/opentxs/basket/BasketContract.hpp
/usr/local/src/opentxs/src/basket/BasketContract.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation