view mayachemtools/docs/modules/txt/TimeUtil.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
line wrap: on
line source

NAME
    TimeUtil

SYNOPSIS
    use TimeUtil;

    use TimeUtil qw(:all);

DESCRIPTION
    TimeUtil module provides the following functions:

    CTimeStamp, FPFileTimeStamp, ISO8601Date, ISO8601Time, ISO8601TimeStamp,
    MonthNameToNumber, MonthNumberToAbbreviatedName, MonthNumberToFullName,
    PDBFileTimeStamp, SDFileTimeStamp, TimeStamp, WeekDayNameToNumber,
    WeekDayNumberToAbbreviatedName, WeekDayNumberToFullName

FUNCTIONS
    CTimeStamp
            $CTimeStamp = CTimeStamp();

        Returns CTimeStamp string using the following format: WDay Mon MDay
        HH:MM:SS YYYY

    FPFileTimeStamp
            $FPFileTimeStamp = FPFileTimeStamp();

        Returns fingerints FP file time stamp string for MayaChemTools
        package. It corresponds to CTimeStamp.

    ISO8601Date
            $Date = ISO8601Date();

        Returns ISO8601 Date string using the following format:
        [YYYY]-[MM]-[DD]

    ISO8601Time
            $Time = ISO8601Time();

        Returns ISO8601 Time string using the following extended format:
        [hh]:[mm]:[ss]

    ISO8601TimeStamp
            $TimeStamp = ISO8601TimeStamp();

        Returns ISO8601 TimeStamp string using the following extended
        format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]

    MonthNameToNumber
            $Number = MonthNameToNumber($Name);

        Return month Number for full month *Name* or three letter
        abbreviated month *Name*.

    MonthNumberToAbbreviatedName
            $AbbrevMonthName = MonthNumberToAbbreviatedName($Number);

        Returns three letter AbbrevMonthName for month *Number*.

    MonthNumberToFullName
            $Name = MonthNumberToFullName($Number);

        Returns full month Name for month *Number*.

    PDBFileTimeStamp
            $TimeStamp = PDBFileTimeStamp();

        Returns PDB file TimeStamp using the following format: DD-MMM-YY

    SDFileTimeStamp
            $TimeStamp = SDFileTimeStamp();

        Returns SD file TimeStamp using the following format: MMDDYYHHMM

    TimeStamp
            $TimeStamp = TimeStamp();

        Returns deafult *TimeStamp* for MayaChemTools. It corresponds to
        CTimeStamp.

    WeekDayNameToNumber
            $Number = WeekDayNameToNumber($Name);

        Returns week day Number from full week day *Name* or three letter
        abbreviated week day *Name*.

    WeekDayNumberToAbbreviatedName
            $Name = WeekDayNumberToAbbreviatedName($Number);

        Returns three letter abbreviates week day Name for week day
        *Number*.

    WeekDayNumberToFullName
            $Name = WeekDayNumberToFullName($Number);

        Returns full week day Name for week day *Number*.

AUTHOR
    Manish Sud <msud@san.rr.com>

SEE ALSO
    FileUtil.pm, TextUtil.pm

COPYRIGHT
    Copyright (C) 2015 Manish Sud. All rights reserved.

    This file is part of MayaChemTools.

    MayaChemTools is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.