src.cdm.product.common.schedule.RateSchedule.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation

There is a newer version: 6.0.0-dev.89

# pylint: disable=line-too-long, invalid-name, missing-function-docstring
# pylint: disable=bad-indentation, trailing-whitespace, superfluous-parens
# pylint: disable=wrong-import-position, unused-import, unused-wildcard-import
# pylint: disable=wildcard-import, wrong-import-order, missing-class-docstring
# pylint: disable=missing-module-docstring
from __future__ import annotations
from typing import List, Optional
import datetime
import inspect
from decimal import Decimal
from pydantic import Field
from rosetta.runtime.utils import (
    BaseDataClass, rosetta_condition, rosetta_resolve_attr
)
from rosetta.runtime.utils import *

__all__ = ['RateSchedule']


class RateSchedule(BaseDataClass):
    """
    A class defining a schedule of rates or amounts in terms of an initial value and then a series of step date and value pairs. On each step date the rate or amount changes to the new step value. The series of step date and value pairs are optional. If not specified, this implies that the initial value remains unchanged over time.
    """
    price: AttributeWithAddress[cdm.observable.asset.PriceSchedule.PriceSchedule] | cdm.observable.asset.PriceSchedule.PriceSchedule = Field(..., description="The initial rate. An initial rate of 5% would be represented as 0.05.")
    """
    The initial rate. An initial rate of 5% would be represented as 0.05.
    """

import cdm 
import cdm.observable.asset.PriceSchedule