RomDataGroup: Nested Property Object

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

Nested Property Object

Description

Object for storing a group of properties

Details

Has standard methods for managing data and meta data related to groups of related properties (e.g. children and parents). Typically called from RomPropertyTree, which inherits this object class

Value

Instance of RomDataGroup or, more likely, RomPropertyTree which is the only Rom object to inherit this object class

an updated config if necessary or FALSE if it fails

the data from the remote connection

the variable definition object for this entity

Public fields

datasource

RomDataSource typically estbalished via the DEQ config file and should contain any relevant database connections

pk_name

the name of this entity's primary key column. Most often root_pid, but consult the Hydrotools ReadMe for more information

Methods

Public methods

• RomDataGroup$new()

• RomDataGroup$handle_config()

• RomDataGroup$from_list()

• RomDataGroup$load_data()

• RomDataGroup$get_vardef()

• RomDataGroup$load_plugin()

• RomDataGroup$clone()

---

Method new()

Usage

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

Arguments

datasource

URL of some RESTful repository or the host of the target database. At DEQ, this is defined in the default config files.

config

list of attributes to get, see also: to_list() for format. These are passed to RomDataSource$get()

load_remote

automatically query REST data source or remote datasource for matches?

Returns

object instance of RomDataGroup or instance of whatever object inherited this class, most likely RomPropertyTree. It will be populated with relevant fields.

---

Method handle_config()

Usage

RomDataGroup$handle_config(config)

Arguments

config

#A list of requests to pass to RomDataSource$get()

---

Method from_list()

Usage

RomDataGroup$from_list(config)

Arguments

config

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

Returns

NULL

---

Method load_data()

Usage

RomDataGroup$load_data(config, load_remote)

Arguments

config

load_remote

automatically query remote data source for matches?

---

Method get_vardef()

Usage

RomDataGroup$get_vardef(config = FALSE, refresh = FALSE)

Arguments

config

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

refresh

automatically refresh var info?

---

Method load_plugin()

Usage

RomDataGroup$load_plugin()

Returns

nothing, but loads the objects plugin

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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