RomAdminFeature: Feature entity data object

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

Feature entity data 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 RomAdminFeature

Super class

hydrotools::RomEntity -> RomAdminFeature

Public fields

base_entity_type

kind of entity

pk_name

the name of this entity's pk column

name

of this entity

admincode

alpha code for this entity from original dataset

ftype

feature type

adminid

unique ID (integer)

bundle

main content type, i.e. facility, well, intake, ...

fstatus

entity status

description

notes field

mps

linked features

geom

feature geometry WKT

base_only

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

Methods

Public methods

• RomAdminFeature$new()

• RomAdminFeature$get_id()

• RomAdminFeature$to_list()

• RomAdminFeature$from_list()

• RomAdminFeature$add_mp()

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

---

Method new()

Usage

RomAdminFeature$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 data source for matches?

Returns

object instance

---

Method get_id()

Usage

RomAdminFeature$get_id()

Returns

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

---

Method to_list()

Usage

RomAdminFeature$to_list(base_only)

Arguments

base_only

include only base table columns (TRUE) or add fields (FALSE)

Returns

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

---

Method from_list()

Usage

RomAdminFeature$from_list(config)

Arguments

config

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

Returns

NULL

---

Method add_mp()

Usage

RomAdminFeature$add_mp(thismp)

Arguments

thismp

mp entity

Returns

add a connected MP. TBD

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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