RomProperty: Time Series data object

In HARPgroup/hydro-tools: Data processing and accessors for VAHydro

Time Series data object

Description

Object for storing single time series value or a description of another property or feature entity

Details

Has standard methods for managing data and meta data including post, from_list, to_list, delete. See RomProperty code for all methods. Inherits other methods from RomEntity

Value

reference class of type openmi.om.base e.g. a RomProperty that will have its essential fields stored on itself with REST or ODBC methods to post and delete base entity

an updated config if necessary or FALSE if it fails

Super class

hydrotools::RomEntity -> RomProperty

Public fields

base_entity_type

kind of entity

pk_name

the name of this entity's pk column

pid

unique ID in this RomDataSource

featureid

id of entity this is attached to

entity_type

type of entity this is attached to

has_vardef

is pluggable?

propname

locally unique name

startdate

begin timestamp

enddate

end time stamp

propvalue

numerical value

propcode

alphanumeric value

proptext

alphanumeric value

data_matrix

json matrix

varid

variable ID from RomDataSource

bundle

(for future use)

uid

user id of creator

vid

current revision (pk in dh_properties_revision)

module

related module (optional?)

matrix_revision_id

pk for foreign table

modified

timestamp

datasource

RomDataSource

tree_loaded

- this is a switch to enable fast loading of export tree from local storage

sql_select_from

syntax to use to select via an odbc or other SQL based datasource

base_only

- how to export to list in case of complex multi table entity and ODBC

Methods

Public methods

• RomProperty$get_id()

• RomProperty$new()

• RomProperty$handle_config()

• RomProperty$from_list()

• RomProperty$to_list()

• RomProperty$save()

• RomProperty$save_matrix()

• RomProperty$save_field()

• RomProperty$delete()

• RomProperty$set_matrix()

• RomProperty$delete_fields()

• RomProperty$clone()

Inherited methods

• hydrotools::RomEntity$get_prop()
• hydrotools::RomEntity$get_vardef()
• hydrotools::RomEntity$insure_varid()
• hydrotools::RomEntity$load_data()
• hydrotools::RomEntity$load_plugin()
• hydrotools::RomEntity$propvalues()
• hydrotools::RomEntity$set_prop()
• hydrotools::RomEntity$tsvalues()

---

Method get_id()

Usage

RomProperty$get_id()

Returns

get_id the id of this entity alias to remote pkid, subclassed as function

---

Method new()

Usage

RomProperty$new(datasource = NULL, config = list(), load_remote = FALSE)

Arguments

datasource

URL of some RESTful repository

config

list of attributes to set, see also: to_list() for format

load_remote

automatically query REST data source for matches?

Returns

object instance

---

Method handle_config()

Usage

RomProperty$handle_config(config)

Arguments

config

---

Method from_list()

Usage

RomProperty$from_list(config)

Arguments

config

list of attributes to set, see also: to_list() for format

Returns

NULL

---

Method to_list()

Usage

RomProperty$to_list(base_only = FALSE)

Arguments

base_only

whether to only use base columns (TRUE) or add fields (FALSE)

Returns

list of object attributes suitable for input to new() and from_list() methods

---

Method save()

Usage

RomProperty$save(push_remote = FALSE)

Arguments

push_remote

whether to automatically propagate changes to remote data source

Returns

boolean TRUE on success, FALSE on failure

---

Method save_matrix()

Usage

RomProperty$save_matrix()

Returns

NULL

---

Method save_field()

Usage

RomProperty$save_field(
  class_field_name,
  field_table,
  value_pairs,
  pkeys = c("entity_type", "entity_id")
)

Arguments

class_field_name

what is this field called on this object (deprecated)

field_table

table to insert into

value_pairs

attriutes to add to insert above the basic entity info (field value here)

pkeys

whether to automatically propagate changes to remote data source

Returns

NULL

---

Method delete()

Usage

RomProperty$delete(delete_remote = FALSE)

Arguments

delete_remote

update locally only or push to remote database

Returns

NULL

---

Method set_matrix()

Takes in a data frame where each column represents a row to store in the data matrix of this object. This method tranposes that data frame while trying to maintain data strcutures and types

Usage

RomProperty$set_matrix(row_cols)

Arguments

row_cols

A data frame of rows that will be transposed to meet final model or property structure e.g. data.frame(c(1,'foo'), c(2,'bar'), c(3,'bingo')) will be coerced to data.frame(c(1,2,3), c('foo','bar','bingo'))

Returns

Nothing, but will set the data_matrix field on RomProperty instance

---

Method delete_fields()

Usage

RomProperty$delete_fields(delete_remote = FALSE)

Arguments

delete_remote

update locally only or push to remote database

Returns

NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RomProperty$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

RomEntity, RomFeature, RomDatasource

Examples

NA

HARPgroup/hydro-tools documentation built on July 4, 2025, 11:05 a.m.