/*****************************************************************************
*                                                                            *
*   HOURS2SECONDS.SPL Copyright (C) 2024 DSP Development Corporation         *
*                               All Rights Reserved                          *
*                                                                            *
*   Author:        Randy Race                                                *
*                                                                            *
*   Synopsis:      Converts hours to seconds                                 *
*                                                                            *
*   Revisions:      2 Dec 2024  RRR  Creation                                *
*                                                                            *
*****************************************************************************/


#if @HELP_HOURS2SECONDS

    HOURS2SECONDS

    Purpose: Converts hours to seconds.

    Syntax:  HOURS2SECONDS(hours)

              hours - A scalar or series, the hours values.


    Returns: A scalar or series of seconds values.

    Example:
             hours2seconds(3)

             returns 10800, the number of seconds in 3 hours.

    Example:
             seconds2hours(hours2seconds(3))

             returns 3 hours showing seconds2hours and hours2seconds are
             inverse functions.

    Example:
             W1: 0..0.2..1
             W2: hours2seconds(w1)
             W3: seconds2hours(w2)

             W1 contains the hours series {0, 0.2, 0.4, 0.6, 0.8, 1.0}.

             W2 contains the seconds series {0, 720, 140, 2160, 2880, 3600}.

             W3 recovers the original hours series.

    Remarks:
             HOURS2SECONDS converts an hour value or series to seconds.

             See SECONDS2HOURS to convert a seconds value or series to
             hours.

    See Also:
             HOURS2DAYS
             HOURS2MINUTES
             HOURS2SECONDS
             HOURS2YEARS
             SECONDS2HOURS
#endif


/* convert hours to seconds */
hours2seconds(hours = 0)
{
        local seconds;

        seconds = hours * 3600;

        if (isarray(seconds))
        {
                setvunits(seconds, "Seconds", -1);
        }

        return(seconds);
}