RomVariableDefinition: Nested Property Object

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

Nested Property Object

Description

Object for storing a single feature with attribute and timeseries related

Details

Has standard methods for managing data and meta data

Value

feature class of type RomFeature

the data from the remote connection

instance of dHVariablePlugin

Super class

hydrotools::RomEntity -> RomVariableDefinition

Public fields

base_entity_type

kind of entity

pk_name

the name of this entity's pk column

varkey

The unique alphanumeric key for this variable

varname

the name of this entity

varcode

alpha code for this entity from original dataset

varid

duplicate of hydroid, more common name

hydroid

unique ID (integer)

varunits

cfs/MGD, ...

plugin

handler code for advanced operations

vardesc

notes field

vocabulary

group that this belongs to

datatype

type of data

multiplicity

determine allowable uniqueness

Methods

Public methods

• RomVariableDefinition$new()

• RomVariableDefinition$get_id()

• RomVariableDefinition$to_list()

• RomVariableDefinition$from_list()

• RomVariableDefinition$save()

• RomVariableDefinition$load_data()

• RomVariableDefinition$get_plugin()

• RomVariableDefinition$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_plugin()
• hydrotools::RomEntity$propvalues()
• hydrotools::RomEntity$save_field()
• hydrotools::RomEntity$set_prop()
• hydrotools::RomEntity$tsvalues()

---

Method new()

Usage

RomVariableDefinition$new(datasource = NULL, config, load_remote = FALSE)

Arguments

datasource

RESTful repository object

config

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

load_remote

automatically query REST dataa source for matches?

Returns

object instance

---

Method get_id()

Usage

RomVariableDefinition$get_id()

Returns

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

---

Method to_list()

Usage

RomVariableDefinition$to_list()

Returns

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

---

Method from_list()

Usage

RomVariableDefinition$from_list(config)

Arguments

config

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

Returns

NULL

---

Method save()

Usage

RomVariableDefinition$save(push_remote = FALSE)

Arguments

push_remote

update locally only or push to remote database

Returns

NULL

---

Method load_data()

Usage

RomVariableDefinition$load_data(config, load_remote)

Arguments

config

load_remote

automatically query remote data source for matches?

---

Method get_plugin()

Usage

RomVariableDefinition$get_plugin(thisobject)

Arguments

thisobject

an instance of RomEntity with vardef enabled

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RomVariableDefinition$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.