R/Constructors.r

In AndyCampbell/rAcoS4: Acoustic Survey Data Processing

#Constructor functions,
#wrap the call to "new"
#function name matches the class name (lowercase)

#constructor for class GeoPoint
geopoint <- function(lat=NA_real_,lon=NA_real_){
  #cat("~~~ geopoint:constructor ~~~\n");
  new(Class="GeoPoint",lat=lat,lon=lon)
}

#constructor for class WayPoint
waypoint <- function(time=NA,lat=NA_real_,lon=NA_real_,heading=NA_real_,
                     depth=NA_real_,speed=NA_real_,depth_unit="m",speed_unit="knots"){
  #cat("~~~ waypoint:constructor ~~~\n");
  new(Class="WayPoint",
      time=(if (is.na(time)) {strptime("1jan1900 00:00:00","%d%b%Y %H:%M:%S")} else {time}),
      lat=lat,lon=lon,
      heading=heading,depth=depth,speed=speed,
      depth_unit=depth_unit,speed_unit=speed_unit)
}

cruise <- function(countrycode,code,name=NA_character_,desc=NA_character_,
                   vesselname=NA_character_,callsign=NA_character_,start_date=NA,end_date=NA,
                   target_common=NA_character_,target_scientific=NA_character_){

  #cat("~~~ cruise:constructor ~~~\n");
  new(Class="Cruise",countrycode = countrycode,code=code,name=name,desc=desc,vesselname=vesselname,
      callsign=callsign,start_date=start_date,end_date=end_date,target_common=target_common,
      target_scientific=target_scientific)
}

ctdstation <- function(lat,lon,code,cruise_code,
                       time=as.POSIXlt(strptime("0000-00-00 00:00:00","%Y-%m-%d %H:%M:%S")),
                       depth=0,depth_unit="m"){
  #cat("~~~ CTDStation:constructor ~~~\n");
  new(Class="CTDStation",lat=lat,lon=lon,code=code,cruise_code=cruise_code,
      time=time,depth=depth,depth_unit=depth_unit)
}

haul <- function(code,cruise_code,valid=TRUE,wirelength=NA_real_,towspeed=NA_real_,
                 trawldepth=NA_real_,shoot_wp=NULL,haul_wp=NULL,species=NULL){
  #cat("~~~ Haul:constructor ~~~\n");
  new(Class="Haul",code=code,cruise_code=cruise_code,valid=valid,
      wirelength=wirelength, towspeed = towspeed, trawldepth = trawldepth,
      shoot_wp=shoot_wp,haul_wp=haul_wp,species=species)
}

transect <- function(code,stratum_code,cruise_code,start_pos,end_pos,
                     start_time,end_time){
  #cat("~~~ Transect:constructor ~~~\n");
  new(Class="Transect",code = code,stratum_code = stratum_code,cruise_code = cruise_code,
      start_pos = start_pos,end_pos = end_pos,start_time = start_time,end_time = end_time)
}

stratum <- function(code,cruise_code,type,boundary_lat,boundary_lon,ICESarea){
  #cat("~~~ Stratum:constructor ~~~\n");
  new(Class="Stratum",code = code,cruise_code = cruise_code,type = type,
      boundary_lat = boundary_lat,boundary_lon = boundary_lon,
      ICESarea = ICESarea)
}

marktype <- function(name,cruise_code,NASC_name,species,include,haul_assignment,
                     mixed_with=NA_character_,hauls){
  #cat("~~~ MarkType:constructor ~~~\n");
  new(Class = "MarkType",name = name,cruise_code = cruise_code,NASC_name = NASC_name,
      species = species,include = include,haul_assignment = haul_assignment,
      mixed_with = mixed_with,hauls = hauls)
}

targetspecies <- function(species,common_name,AphiaID,LF_bin_size,ts_a,ts_b,ts_LFint,imm_codes=NA_real_,
                          mat_codes=NA_real_,spt_codes=NA_real_,est_abd=FALSE,est_by_age=FALSE,
                          est_by_mat=FALSE){
  #cat("~~~ TargetSpecies:constructor ~~~\n");
  new(Class = "TargetSpecies",species = species,common_name = common_name,AphiaID = AphiaID,
             LF_bin_size = LF_bin_size,ts_a = ts_a,ts_b = ts_b,ts_LFint = ts_LFint,
             imm_codes = imm_codes,mat_codes = mat_codes,spt_codes = spt_codes,
             est_abd = est_abd,est_by_age = est_by_age,est_by_mat = est_by_mat)
}

mark <- function(cruise_code,stratum_code,transect_code,
                 school_length,cell_length,NASC,position,marktype_name,
                 haul_code = NA_character_,LF=NA_real_,CS=NA_real_,
                 nearest_transect = NA_character_){
  #cat("~~~ Mark:constructor ~~~\n");
  new(Class = "Mark",cruise_code = cruise_code,stratum_code = stratum_code,
      transect_code = transect_code,school_length = school_length,cell_length = cell_length,
      NASC = NASC,position = position,marktype_name = marktype_name,
      haul_code = haul_code,LF = LF,CS = CS,nearest_transect = nearest_transect)
}