SMP.Classes.BV_VARIABLE_COUPON_BOND_SCHEDULE.h

Go to the documentation of this file.

#pragma once
/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable ONIXS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/


/*
--------------
GENERATED FILE
--------------
*/


#include <string>
#include <OnixS/MTS/BondVision/SDP/Defines.h>
#include <OnixS/MTS/BondVision/SDP/SMP.ClassIds.h>
#include <OnixS/MTS/BondVision/SDP/SMP.Enumerations.h>


namespace OnixS {
namespace Mts {
namespace BondVision {
namespace SDP {



///
class ONIXS_MTS_BONDVISION_SDP_API BV_VARIABLE_COUPON_BOND_SCHEDULE : public Class
{
public:
    BV_VARIABLE_COUPON_BOND_SCHEDULE()
    {
    }

    virtual ~BV_VARIABLE_COUPON_BOND_SCHEDULE() {}

    /// Class id
    virtual ClassId::Enum id() const
    {
        return ClassId::BV_VARIABLE_COUPON_BOND_SCHEDULE;
    }

    /// Unique ID of the financial instrument (Bond)
    UInt32 financialInstrumentId;

    /// Date when the coupon plan changes type or formula
    UInt32 formulaResetDate;

    /// Specifies if the Coupon Type is Fixed or Floating
    TI_COUPON_TYPE::Enum couponType;

    /// Coupon Rate
    Double couponRate; // DOUBLE presentation

    /// ID of the Benchmark used in the coupon rate calculation in case of floating coupons
    UInt32 benchmarkId;

    /// Margin used in the coupon rate calculation in case of floating coupons
    Double margin; // DOUBLE presentation

    /// Day Count used in the coupon rate calculation in case of floating coupons
    TI_DAY_COUNT_CONVENTION_TYPE::Enum dayCountConventionType;

    /// Coupon Frequency
    UInt16 couponFrequency;

    /// Maximum value the coupon can assume
    Double cap; // DOUBLE presentation

    /// Minimum value the coupon can assume
    Double floor; // DOUBLE presentation


    /// 
    size_t deserialize(const void* buf, size_t inLen);

    /// Provides string presentation
    virtual std::string toString () const;

    /// 
    virtual size_t serializationBufSize() const { return 56; }

    /// 
    virtual BV_VARIABLE_COUPON_BOND_SCHEDULE* clone() const;

    virtual BV_VARIABLE_COUPON_BOND_SCHEDULE* clone(void*) const;

private:
    virtual size_t serialize(void* buf) const;

};


}
}
}
}