R/NullValues.R

In factset.protobuf.stach: 'FactSet' 'STACH' Library

#' @docType class
#' @title factset.protobuf.stach.NullValues
#' @description Class defining the NullValues of various data types
#' @format An \code{R6Class} generator object
#' @field DOUBLE Null value for DOUBLE data type
#' @field FLOAT Null value for FLOAT data type
#' @field INT32 Null value for INT32 data type
#' @field INT64 Null value for INT64 data type
#' @field STRING Null value for STRING data type
#' @field TIMESTAMP Null value for TIMESTAMP data type
#' @field DURATION Null value for DURATION data type
#' @examples
#' nullValues <- factset.protobuf.stach.NullValues$new()
#'
#' # Null value comparison for Protobuf's String data type.
#' a <- 'null'
#' if(nullValues$STRING == a) print("a is the null") else print("a is not a null")
#'
#' # Null value comparison for Protobuf's Int32 data type.
#' b <- new(google.protobuf.Int32Value, value = 2147483647)
#' if(nullValues$INT32 == b$value) print("b is the null") else print("b is not a null")
#'
#' # Null value comparison for Protobuf's Duration data type.
#' c <- new(google.protobuf.Duration, seconds = 315576000000, nanos = 999999900)
#' if(nullValues$DURATION == c) print("c is the null") else print("c is not a null")
#' @importFrom R6 R6Class
#' @export
factset.protobuf.stach.NullValues <- R6::R6Class(
  'factset.protobuf.stach.NullValues',
  public = list(

    DOUBLE = NaN,
    FLOAT = NaN,
    INT32 = 2147483647,
    INT64 = 9223372036854775807,
    STRING = "null",
    TIMESTAMP = NULL,
    DURATION = NULL,

    initialize = function(){
      library(RProtoBuf)
      self$TIMESTAMP = new(google.protobuf.Timestamp, seconds = 253402300799, nanos = 0)
      self$DURATION = new(google.protobuf.Duration, seconds = 315576000000, nanos = 999999900)
    }
  )
)