RomTS: 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

Details

Has standard methods for managing data and meta data

Value

reference class of type openmi.om.base.

Super class

hydrotools::RomEntity -> RomTS

Public fields

base_entity_type

kind of entity

pk_name

the name of this entity's pk column

has_vardef

is pluggable?

tid

unique ID in this RomDataSource

featureid

id of entity this is attached to

entity_type

type of entity this is attached to

tstime

begin timestamp

tsendtime

end time stamp

tsvalue

numerical value

tscode

alphanumeric value

tlid

timeline ID (for future use)

varid

variable ID from RomDataSource

bundle

(for future use)

uid

user id of creator

modified

timestamp

datasource

RomDataSource

sql_select_from

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

Methods

Public methods

• RomTS$get_id()

• RomTS$new()

• RomTS$from_list()

• RomTS$to_list()

• RomTS$set_prop()

• RomTS$save()

• RomTS$clone()

Inherited methods

• hydrotools::RomEntity$delete()
• hydrotools::RomEntity$get_prop()
• hydrotools::RomEntity$get_vardef()
• hydrotools::RomEntity$handle_config()
• hydrotools::RomEntity$insure_varid()
• hydrotools::RomEntity$load_data()
• hydrotools::RomEntity$load_plugin()
• hydrotools::RomEntity$propvalues()
• hydrotools::RomEntity$save_field()
• hydrotools::RomEntity$tsvalues()

---

Method get_id()

Usage

RomTS$get_id()

Returns

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

---

Method new()

Usage

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

Arguments

datasource

optional RomDataSource for remote and local storage

config

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

load_remote

automatically query REST data source for matches?

site

URL of some RESTful repository

Returns

object instance

---

Method from_list()

Usage

RomTS$from_list(config)

Arguments

config

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

Returns

NULL

---

Method to_list()

Usage

RomTS$to_list()

Returns

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

---

Method set_prop()

Usage

RomTS$set_prop(name, value, format = "default")

Arguments

name

attribute name

value

attribute value

format

type of data being sent (default, json, ...)

Returns

object instance

---

Method save()

Usage

RomTS$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 clone()

The objects of this class are cloneable with this method.

Usage

RomTS$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

NA

Examples

NA

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