class.sim_input: Simulation input class

Description Usage Arguments Format Details Slots Make a simulation input object See Also Examples

Description

Objects of the sim_input class store objects of the input class (see class.input. The use of the sim_input class is to put all of the necessary input objects together for a simulation. During the simulation, the sim_input object will contain the values of the inputs at any given time.

Usage

1
2
3
4
5

Arguments

...

The names of the desired input objects, separated by commas.

Format

The show method prints the sim_input object as a data frame, which is what it would print out as without the show method.

Details

make.sim_input for making a sim_input object.

There is a show method for the sim_input class. This method can be removed with the remove.sim_inout.show function and reinstated with the sim_input.show. This show method does not do anything different to if the object were just printed normally.

In a simulation, sim_input is used to monitor the value of the inputs, which serve as arguments for the functions that are necessary to operate a given model. See the section below. See input_monitor.

Slots

input

This is a list of the input objects that are required for a simulation.

Make a simulation input object

To create an object of sim_input, use the function make.sim_input.

See Also

make.custom_input to make input objects.

input_monitor for when sim_input is used in a simulation.

Examples

1
2
3
4
5
# Make some input objects
test_input1 = make.custom_input( "test_input1" )
test_input2 = make.custom_input( "test_input2" )
# Make a sim_input object
make.sim_input( test_input1, test_input2 )

Don-Li/CAB_original documentation built on May 6, 2019, 2:53 p.m.