R/timeSeries-slotTime.R

In timeSeries: Financial Time Series Objects (Rmetrics)

#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program 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.
#
#  A copy of the GNU General Public License is available at
#  ../../COPYING


################################################################################
# FUNCTION:                 DESCRIPTION:
#  time,timeSeries           Extracs time positions from a 'timeSeries'
#  time<-                    Defines S3 UseMethod
#  time<-.timeSeries         ... to avoid problems with zoo
# FUNCTION:                 DESCRIPTION:
#  getTime                   Get time slot from a 'timeSeries'  
#  setTime<-                 Set new time slot to a 'timeSeries'
################################################################################
# DEPRECATED:               DESCRIPTION:
#  seriesPositions           Deprecated, use time
#  newPositions<-            Deprecated, use time<-
################################################################################

## GNB: swapped the definitions of .time.timeSeries and time.timeSeries
##      in preparation to drop the former
##   .time.timeSeries <- 
time.timeSeries <- 
    function(x, ...)
{
    # A function implemented by Diethelm Wuertz and Yohan Chalabi

    # Description:
    #   Extracs time positions from a 'timeSeries'

    # Arguments:
    #   x - a 'timeSeries' object.

    # Value:
    #   Returns a time resampled object of class 'timeSeries'.

    # FUNCTION:

    if (length(x@positions)>0)
        timeDate(x@positions, zone = "GMT",
                 FinCenter = x@FinCenter)
    else
        seq.int(NROW(x))
}

## setMethod("time", "timeSeries", time.timeSeries)


# ------------------------------------------------------------------------------


`time<-` <-
function(x, value)
{
    UseMethod("time<-")
}


# ------------------------------------------------------------------------------

`time<-.default` <-
function(x, value)
{
    # A function implemented by Georgi Boshnakov

    zoo::time(x) <- value
    x
}

`time<-.timeSeries` <-
function(x, value)
{
    # A function implemented by Yohan Chalabi
    
    # Note:
    #   To avoid conflict with zoo package.

    # FUNCTION:
    
    # Assign Rownames:
    rownames(x) <- value
    
    # Return Value:
    x
}


###############################################################################


getTime <- 
    function(x)
{
    # Description:
    #   Get time slot from a 'timeSeries' object.
    
    # Arguments:
    #   x - a 'timeSeries' object
    
    # FUNCTION:
    
    # Return Value:
    time(x)    
}


# ------------------------------------------------------------------------------


"setTime<-" <-
    function(x, value)
{
    # Description:
    #   Set time slot to a 'timeSeries' object.

    # Arguments:
    #   x - a 'timeSeries' object
    
    # FUNCTION:
    
    # Assign Time Slot:
    time(x) <- value
    
    # Return Value:
    x    
}


###############################################################################
# DEPRECATED


## seriesPositions <-
##     function(object)
## {
##     # A function implemented by Diethelm Wuertz
## 
##     # Description:
##     #   Extracts the positions of a 'timeSeries' objects and
##     #   converts them to a 'timeDate' object.
## 
##     # Arguments:
##     #   object - a 'timeSeries' object
## 
##     # Value:
##     #   Returns 'timeSeries' positions as 'timeDate' objects.
## 
##     # FUNCTION:
## 
##     # Deprecated:
##     .Deprecated(new = "time", package = "timeSeries")
## 
##     # Return Value:
##     time(object)
## }


# ------------------------------------------------------------------------------
# Deprecated:


## "newPositions<-" <-
##     function(object, value)
## {   # A function implemented by Diethelm Wuertz
## 
##     # FUNCTION:
## 
##     # Deprecated:
##     .Deprecated(new = "time<-", package = "timeSeries")
## 
##     # Assign Rownames:
##     rownames(object) <- value
## 
##     # Return Value:
##     object
## }


################################################################################