ScriptedTradeEventData Class Reference

#include <ored/portfolio/scriptedtrade.hpp>

Inheritance diagram for ScriptedTradeEventData:

Collaboration diagram for ScriptedTradeEventData:

Public Types
enum class	Type { Value , Array , Derived }

Public Member Functions
	ScriptedTradeEventData ()
	ScriptedTradeEventData (const std::string &name, const std::string &date)
	ScriptedTradeEventData (const std::string &name, const ScheduleData &schedule)
	ScriptedTradeEventData (const std::string &name, const std::string &baseSchedule, const std::string &shift, const std::string &calendar, const std::string &convention)
virtual void	fromXML (XMLNode *node) override
virtual XMLNode *	toXML (ore::data::XMLDocument &doc) const override
Type	type () const
const std::string &	name () const
const std::string &	value () const
const ScheduleData &	schedule () const
const std::string &	baseSchedule () const
const std::string &	shift () const
const std::string &	calendar () const
const std::string &	convention () const
const bool	hasData ()
Public Member Functions inherited from XMLSerializable
virtual	~XMLSerializable ()
virtual void	fromXML (XMLNode *node)=0
virtual XMLNode *	toXML (XMLDocument &doc) const =0
void	fromFile (const std::string &filename)
void	toFile (const std::string &filename) const
void	fromXMLString (const std::string &xml)
	Parse from XML string. More...
std::string	toXMLString () const
	Parse from XML string. More...

Private Attributes
Type	type_
std::string	name_
std::string	value_
ScheduleData	schedule_
std::string	baseSchedule_
std::string	shift_
std::string	calendar_
std::string	convention_

Detailed Description

Definition at line 33 of file scriptedtrade.hpp.

Member Enumeration Documentation

Type

enum class Type

strong

Enumerator
Value
Array
Derived

Definition at line 35 of file scriptedtrade.hpp.

{ Value, Array, Derived };

Constructor & Destructor Documentation

ScriptedTradeEventData() [1/4]

ScriptedTradeEventData

(

)

Definition at line 37 of file scriptedtrade.hpp.

: type_(Type::Value) {}

ScriptedTradeEventData() [2/4]

ScriptedTradeEventData	(	const std::string &	name,
		const std::string &	date
	)

Definition at line 39 of file scriptedtrade.hpp.

        : type_(Type::Value), name_(name), value_(date) {}

ScriptedTradeEventData() [3/4]

ScriptedTradeEventData	(	const std::string &	name,
		const ScheduleData &	schedule
	)

Definition at line 42 of file scriptedtrade.hpp.

        : type_(Type::Array), name_(name), schedule_(schedule) {}

ScriptedTradeEventData() [4/4]

ScriptedTradeEventData	(	const std::string &	name,
		const std::string &	baseSchedule,
		const std::string &	shift,
		const std::string &	calendar,
		const std::string &	convention
	)

Definition at line 45 of file scriptedtrade.hpp.

        : type_(Type::Derived), name_(name), baseSchedule_(baseSchedule), shift_(shift), calendar_(calendar),
          convention_(convention) {}

Member Function Documentation

fromXML()

void fromXML ( XMLNode *  node )

overridevirtual

Implements XMLSerializable.

Definition at line 417 of file scriptedtrade.cpp.

                                                  {
    XMLUtils::checkNode(node, "Event");
    name_ = XMLUtils::getChildValue(node, "Name", true);
    if (XMLNode* v = XMLUtils::getChildNode(node, "Value")) {
        type_ = Type::Value;
        value_ = XMLUtils::getNodeValue(v);
    } else if (XMLNode* v = XMLUtils::getChildNode(node, "ScheduleData")) {
        type_ = Type::Array;
        schedule_.fromXML(v);
    } else if (XMLNode* v = XMLUtils::getChildNode(node, "DerivedSchedule")) {
        type_ = Type::Derived;
        baseSchedule_ = XMLUtils::getChildValue(v, "BaseSchedule", true);
        shift_ = XMLUtils::getChildValue(v, "Shift", true);
        calendar_ = XMLUtils::getChildValue(v, "Calendar", true);
        convention_ = XMLUtils::getChildValue(v, "Convention", true);
    } else {
        QL_FAIL("Expected Value or ScheduleData node");
    }
}

Here is the call graph for this function:

toXML()

XMLNode * toXML ( ore::data::XMLDocument &  doc ) const

overridevirtual

Implements XMLSerializable.

Definition at line 437 of file scriptedtrade.cpp.

                                                             {
    XMLNode* n = doc.allocNode("Event");
    XMLUtils::addChild(doc, n, "Name", name_);
    if (type_ == Type::Value) {
        XMLUtils::addChild(doc, n, "Value", value_);
    } else if (type_ == Type::Array) {
        XMLUtils::appendNode(n, schedule_.toXML(doc));
    } else if (type_ == Type::Derived) {
        XMLNode* d = doc.allocNode("DerivedSchedule");
        XMLUtils::addChild(doc, d, "BaseSchedule", baseSchedule_);
        XMLUtils::addChild(doc, d, "Shift", shift_);
        XMLUtils::addChild(doc, d, "Calendar", calendar_);
        XMLUtils::addChild(doc, d, "Convention", convention_);
        XMLUtils::appendNode(n, d);
    } else {
        QL_FAIL("ScriptedTradeEventData::toXML(): unexpected ScriptedTradeEventData::Type");
    }
    return n;
}

Here is the call graph for this function:

type()

Type type

(

)

const

Definition at line 53 of file scriptedtrade.hpp.

{ return type_; }

Here is the caller graph for this function:

name()

const std::string & name

(

)

const

Definition at line 54 of file scriptedtrade.hpp.

{ return name_; }

Here is the caller graph for this function:

value()

const std::string & value

(

)

const

Definition at line 55 of file scriptedtrade.hpp.

{ return value_; }

schedule()

const ScheduleData & schedule

(

)

const

Definition at line 56 of file scriptedtrade.hpp.

{ return schedule_; }

Here is the caller graph for this function:

baseSchedule()

const std::string & baseSchedule

(

)

const

Definition at line 57 of file scriptedtrade.hpp.

{ return baseSchedule_; }

Here is the caller graph for this function:

shift()

const std::string & shift

(

)

const

Definition at line 58 of file scriptedtrade.hpp.

{ return shift_; }

Here is the caller graph for this function:

calendar()

const std::string & calendar

(

)

const

Definition at line 59 of file scriptedtrade.hpp.

{ return calendar_; }

Here is the caller graph for this function:

convention()

const std::string & convention

(

)

const

Definition at line 60 of file scriptedtrade.hpp.

{ return convention_; }

Here is the caller graph for this function:

hasData()

const bool hasData

(

)

Definition at line 457 of file scriptedtrade.cpp.

                                           {
    if (type_ == Type::Array) {
        return schedule_.hasData();
    } else if (type_ == Type::Derived) {
        return !baseSchedule_.empty() && !shift_.empty() && !calendar_.empty() && !convention_.empty();
    } else if (type_ == Type::Value) {
        return !value_.empty();
    } else {
        // If type_ is not defined, then the ScriptedTradeEventData object is not defined
        return false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

type_

Type type_

private

Definition at line 64 of file scriptedtrade.hpp.

name_

std::string name_

private

Definition at line 65 of file scriptedtrade.hpp.

value_

std::string value_

private

Definition at line 66 of file scriptedtrade.hpp.

schedule_

ScheduleData schedule_

private

Definition at line 67 of file scriptedtrade.hpp.

baseSchedule_

std::string baseSchedule_

private

Definition at line 68 of file scriptedtrade.hpp.

shift_

std::string shift_

private

Definition at line 69 of file scriptedtrade.hpp.

calendar_

std::string calendar_

private

Definition at line 70 of file scriptedtrade.hpp.

convention_

std::string convention_

private

Definition at line 71 of file scriptedtrade.hpp.