dHVariablePluginDefault: dHVariablePluginDefault

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

dHVariablePluginDefault

Description

Handler class for property entities (and timeseries if needed)

Details

Base entity data object

Has standard methods for managing data and meta data

Value

reference class of type openmi.om.base.

Public fields

name

what is it called

object_class

model object type

entity_bundle

model object type

Methods

Public methods

• dHVariablePluginDefault$new()

• dHVariablePluginDefault$exportOpenMI()

• dHVariablePluginDefault$exportOpenMIBase()

• dHVariablePluginDefault$exportOpenMIpost()

• dHVariablePluginDefault$fromOpenMIBase()

• dHVariablePluginDefault$param_info()

• dHVariablePluginDefault$clone()

---

Method new()

Usage

dHVariablePluginDefault$new(config = list())

Arguments

config

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

Returns

object instance

---

Method exportOpenMI()

Usage

dHVariablePluginDefault$exportOpenMI(entity)

Arguments

entity

the local object to work on

Returns

an updated config if necessary or FALSE if it fails

---

Method exportOpenMIBase()

Usage

dHVariablePluginDefault$exportOpenMIBase(entity)

Arguments

entity

the local object to work on

Returns

an updated config if necessary or FALSE if it fails

---

Method exportOpenMIpost()

Usage

dHVariablePluginDefault$exportOpenMIpost(entity, export)

Arguments

entity

the local object to work on

export

list of properties and subproperties to export

---

Method fromOpenMIBase()

Usage

dHVariablePluginDefault$fromOpenMIBase(om_list)

Arguments

om_list

the open MI export array/list to work on

Returns

a Rom importable config or FALSE if it fails

---

Method param_info()

Usage

dHVariablePluginDefault$param_info()

Returns

detailed information about this object in markdown list format

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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