Source code for xerparser.model.classes.calendar

# PyP6XER
# Copyright (C) 2020, 2021 Hassan Emam <hassan@constology.com>
#
# This file is part of PyP6XER.
#
# PyP6XER library is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License v2.1 as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# PyP6XER is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with PyP6XER.  If not, see <https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html>.


from xerparser.model.classes.calendar_data import CalendarData

import locale

[docs]
class Calendar:

[docs]
    obj_list = []


    def __init__(self, params):
        # Unique ID generated by the system.

[docs]
        self.clndr_id = int(params.get('clndr_id').strip()) if params.get('clndr_id') else None

        # Identifies the default global calendar (applies to global calendars only).

[docs]
        self.default_flag = params.get('default_flag').strip() if params.get('default_flag') else None

        # The name of the calendar.

[docs]
        self.clndr_name = params.get('clndr_name').strip() if params.get('clndr_name') else None


[docs]
        self.proj_id = params.get('proj_id').strip() if params.get('proj_id') else None

        # The global calendar to which this calendar is linked.  Any changes to the global calendar are automatically
        #  propagated to this calendar.

[docs]
        self.base_clndr_id = params.get('base_clndr_id').strip() if params.get('base_clndr_id') else None

        # Date of last changes to calendar.

[docs]
        self.last_chng_date = params.get('last_chng_date').strip() if params.get('last_chng_date') else None

        # The calendar type - either global, resource, or project. Global calendars can be assigned to projects and
        # resources. Resource calendars can be assigned only to resources. Project calendars are specific to projects.

[docs]
        self.clndr_type = params.get('clndr_type').strip() if params.get('clndr_type') else None

        # The number of work hours per day. This conversion factor is used for displaying time units and durations in
        #  the user's selected display formats.

[docs]
        self.day_hr_cnt = locale.atof(params.get('day_hr_cnt')) if params.get('day_hr_cnt') else None

        # The number of work hours per week. This conversion factor is used for displaying time units and durations
        # in the user's selected display formats.

[docs]
        self.week_hr_cnt = locale.atof(params.get('week_hr_cnt')) if params.get('week_hr_cnt') else None

        # The number of work hours per month. This conversion factor is used for displaying time units and durations
        # in the user's selected display formats.

[docs]
        self.month_hr_cnt = locale.atof(params.get('month_hr_cnt')) if params.get('month_hr_cnt') else None

        # The number of work hours per year. This conversion factor is used for displaying time units and durations
        # in the user's selected display formats.

[docs]
        self.year_hr_cnt = locale.atof(params.get('year_hr_cnt')) if params.get('year_hr_cnt') else None

        #

[docs]
        self.rsrc_private = params.get('rsrc_private').strip() if params.get('rsrc_private') else None



[docs]
        self.clndr_data = params.get('clndr_data').strip() if params.get('clndr_data') else None


[docs]
        self.working_days = dict()


[docs]
        self.exceptions = []


        if self.clndr_data:
            c = CalendarData(self.clndr_data)
            self.working_days = c.get_days()
            self.working_hours = c.get_work_pattern()
            self.exceptions = c.get_exceptions()
        Calendar.obj_list.append(self)


[docs]
    def get_tsv(self):
        tsv = ['%R', self.clndr_id, self.default_flag, self.clndr_name, self.proj_id,
               self.base_clndr_id, self.last_chng_date, self.clndr_type, self.day_hr_cnt,
               self.week_hr_cnt, self.month_hr_cnt, self.year_hr_cnt, self.rsrc_private,
               self.clndr_data]
        return tsv



[docs]
    def get_id(self):
        return self.clndr_id


    @staticmethod

[docs]
    def find_by_id(id):
        obj = list(filter(lambda x: x.clndr_id == id, Calendar.obj_list))
        if obj:
            return obj[0]
        return None



[docs]
    def __repr__(self):
        return self.clndr_name + ' : ' + str(self.day_hr_cnt) + '\n' + self.clndr_data