src.cdm.base.datetime.Frequency.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__ = ['Frequency']


class Frequency(BaseDataClass):
    """
    A class for defining a date frequency, e.g. one day, three months, through the combination of an integer value and a standardized period value that is specified as part of an enumeration.
    """
    periodMultiplier: int = Field(..., description="A time period multiplier, e.g. 1, 2, or 3. If the period value is T (Term) then period multiplier must contain the value 1.")
    """
    A time period multiplier, e.g. 1, 2, or 3. If the period value is T (Term) then period multiplier must contain the value 1.
    """
    period: cdm.base.datetime.PeriodExtendedEnum.PeriodExtendedEnum = Field(..., description="A time period, e.g. a day, week, month, year or term of the stream.")
    """
    A time period, e.g. a day, week, month, year or term of the stream.
    """
    
    @rosetta_condition
    def condition_0_TermPeriod(self):
        """
        FpML specifies that if period value is T (Term) then periodMultiplier must contain the value 1.
        """
        item = self
        def _then_fn0():
            return all_elements(rosetta_resolve_attr(self, "periodMultiplier"), "=", 1)
        
        def _else_fn0():
            return True
        
        return if_cond_fn(all_elements(rosetta_resolve_attr(self, "period"), "=", rosetta_resolve_attr(PeriodExtendedEnum, "T")), _then_fn0, _else_fn0)
    
    @rosetta_condition
    def condition_1_PositivePeriodMultiplier(self):
        """
        FpML specifies periodMultiplier as a positive integer.
        """
        item = self
        return all_elements(rosetta_resolve_attr(self, "periodMultiplier"), ">", 0)

import cdm 
import cdm.base.datetime.PeriodExtendedEnum
from cdm.base.datetime.PeriodExtendedEnum import PeriodExtendedEnum