ctm-classes: A Reference Class that represents all Contract Models objects

ContractModel-classR Documentation

A Reference Class that represents all Contract Models objects

Description

This class is only used in a virtual sense in that it is not intended to create instances of it. It's use is to provide the class structure, i.e. field definitions, to various implementations of Contract Models for specific Contract Types and as a means for designing method-inheritage.

Details

Generally, a Contract Model has one field that contains a reference to a java object of the same class in the java ACTUS library (e.g. for PrincipalAtMaturityModel the referenced object will be of class org.actus.models.PrincipalAtMaturityModel). Note that the object "carrying" the attribute values, i.e. the Contract Model object, lives in Java, or the JVM respectively, and not in R. Attribute values may be accessed/changed using methods get/set which uses the JNI interface through R-package rJava.

For a list of available contract ContractTerms use method terms. For an explanation of the ContractTerms refer to the official ACTUS data dictionary under www.projectactus.org.

Fields

jref

A rJava java object reference

See Also

ContractType, PrincipalAtMaturityModel, AnnuityModel, StockModel


wbreymann/FEMS documentation built on May 6, 2024, 2:19 p.m.