param_obj: Parameter objects

Description Usage Arguments Value Methods (by class) Examples

Description

Gets or sets the object of a parameter e.g. to an entity() object.

Usage

1
2
3
4
5
6
7
8
9
param_obj(obj, name)

param_obj(obj, name) <- value

## S4 replacement method for signature 'struct_class,character'
param_obj(obj, name) <- value

## S4 method for signature 'struct_class,character'
param_obj(obj, name)

Arguments

obj

An object derived from struct_class

name

Name of parameter

value

A valid value for the parameter being set

Value

param_obj(M,name)

Returns the named parameter as an object

param_obj(M,name)<-

Sets the named parameter of an object

Methods (by class)

Examples

1
2
3
4
5
6
# get the parameter as an object
M = example_model()
obj = param_obj(M, 'value_0')

# set a parameter as an object
param_obj(M, 'value_0') = entity(value = 15,type = 'numeric',name='value_0')

struct documentation built on Nov. 8, 2020, 8:14 p.m.