Logo
Reference manual - version ored_version
Envelope Class Reference

Serializable object holding generic trade data, reporting dimensions. More...

#include <ored/portfolio/envelope.hpp>

Inheritance diagram for Envelope:

Public Member Functions

 Envelope ()
 Default constructor.
 Envelope (const string &counterparty, const string &nettingSetId, const set< string > &portfolioIds=set< string >())
 Constructor with netting set id and portfolio ids, without additional fields.
 Envelope (const string &counterparty, const NettingSetDetails &nettingSetDetails=NettingSetDetails(), const set< string > &portfolioIds=set< string >())
 Constructor with netting set details and portfolio ids, without additional fields.
 Envelope (const string &counterparty, const map< string, string > &additionalFields)
 Constructor without netting set / portfolio ids, with additional fields.
 Envelope (const string &counterparty, const string &nettingSetId, const map< string, string > &additionalFields, const set< string > &portfolioIds=set< string >())
 Constructor with netting set, with additional fields.
 Envelope (const string &counterparty, const NettingSetDetails &nettingSetDetails, const map< string, string > &additionalFields, const set< string > &portfolioIds=set< string >())
 Constructor with netting set details, with additional fields.
Serialisation
virtual void fromXML (XMLNode *node) override
virtual XMLNode * toXML (XMLDocument &doc) const override
Inspectors
const stringcounterparty () const
const stringnettingSetId () const
const NettingSetDetailsnettingSetDetails () const
const set< string > & portfolioIds () const
const map< string, stringadditionalFields () const
const map< string, QuantLib::ext::any > & fullAdditionalFields () const
string additionalField (const std::string &name, const bool mandatory=true, const std::string &defaultValue=std::string()) const
QuantLib::ext::any additionalAnyField (const std::string &name, const bool mandatory=true, const QuantLib::ext::any &defaultValue=QuantLib::ext::nullopt) const
void setAdditionalField (const std::string &key, const QuantLib::ext::any &value)
Public Member Functions inherited from XMLSerializable
void fromFile (const std::string &filename)
void toFile (const std::string &filename) const
void fromXMLString (const std::string &xml)
 Parse from XML string.
std::string toXMLString () const
 Parse from XML string.
std::string toXMLStringUnformatted () const

Utility

bool initialized () const
 Check if the envelope is initialized.
bool hasNettingSetDetails () const
 Check if the netting set details have been populated.

Detailed Description

Serializable object holding generic trade data, reporting dimensions.

Member Function Documentation

◆ fromXML()

virtual void fromXML ( XMLNode * node)
overridevirtual

Implements XMLSerializable.

◆ toXML()

virtual XMLNode * toXML ( XMLDocument & doc) const
overridevirtual

Implements XMLSerializable.