Search

Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Calculation Object

Parent of:

no children

Child of:

- Node

- Document

- DatabaseView 

 

Description

A UserTable is an object that resembles a UserVariable but differs in that a UserVariable can only consist of one element while a UserTable can contain multiple rows. A UserTable is always a table consisting of one column i.e. it is not possible to create a matrix. The values of a UserTable can be used in calculations in the same way as a DataTable. The value(s) of a UserTable are not set in advance in the Editor. Instead the value(s) of a UserTable are determined on the website by the user. For example the user fills in a number of periods in which he wants to save a certain amount of money. For each period that he enters a row will be made in the UserTable containing the specified amount.

Properties

DebugLogMode (from version 4.1)

Indicates the level of detail of debug information that is logged when running a Futurama application (website, webservice, console application) to the trace, a logfile, a database etc. The possible values are:

  • None: no debug information is logged
  • Simple: only basic information is given
  • Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown

DefaultValue

This value will be initially assigned to the rows of the UserTable

IsPublic

Possible values are True or False. If the value is False, then the object can only be used within the document where it is created. If the value is True, then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is True and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to True only when necessary.

ReturnsTable (until version 5.0)

This is an automatic property indicating whether the result of the Calculation object is a table. For a UserTable it is always True. From version 5.1.0 the ReturnsTable property is replaced by the Rank property (see property below).

Rank (from version 5.1)

The Rank property is an automatic property indicating the rank of the Calculation Object. Rank=0 implies a scalar. Rank=1 a vector and Rank=2 a matrix. For an UserTable the Rank=1.

Rows

This property determines the number of rows the UserTable has. The number of rows can be a fixed number resulting in the UserTable always having this number of rows by definition. More common is it to let the number of rows depend on choices of the user in the website. To illustrate this suppose a pensionscheme has a defined contribution part in which a participant has to denote how much he wants to deposit in a certain number of periods. In this case the number of periods the user chooses is not known in advance and consequently the number of rows of the UserTable can't be set in advance as well. If the website is modelled in such a way that the user has to click on a button to add a new period, then the number of clicks could be stored in a UserVariable. The property Rows can then refer to this UserVariable to determine how many rows the UserTable needs to have.

TestValue

The number of rows as well as the values of a UserTable are set in the website by (actions of) the user. Nevertheless it is possible to test the UserTable and the calculations that depend on it in the Editor as well. To do this we 'simulate' that the UserTable has been given a number of rows as well as values in it's rows by creating the table in the property TestValue. When evaluating a UserTable in the Results Window the table in TestValue is shown. The TestValue of a UserTable can be removed by doing a rightclick on the UserTable in the Document Explorer or on the object under which the UserTable is located. Select the option 'Debug' and then 'Clear TestValues' to remove the TestValue of either the selected UserTable or the TestValues of all UserTable (and UserVariables) which occur in the selected object.

XmlName

The name of the object as it is shown in the source of the website. By default the XmlName is equal to the name given in the property (Name) with spaces replaced by underscores, but you are free to change it.

(Name)

The name of the object.

Comment

Here a comment can be entered. For example a short description of the object.

ID

The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window.

Text

Because the value of a UserTable is not set in advance in the Editor but rather in the website, this property is disabled.

Type

The value of this property determines what kind of value can be assigned to the UserTable. They also determine to which objects the UserTable can be connected. The following types are available:

  • Long (an integer)
  • Double (a broken number)
  • Date
  • String
  • Boolean (a logical value which can be True or False)

Objects and UserTables

The same objects that can be connected to a UserVariable can be connected to a UserTable. The difference is that if a connection to a UserTable is made you have to specify, by setting an index, which row in the UserTable is to be used.

Related Topics

- Fixed

- Formula

- DataTable

- Range

- Reference

- UserVariable

 

Updated: 2012-07-23