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

IsCircular

This is an automatic property indicating whether the Formula refers to itself, either directly (in case of a recursive Formula) or indirectly (in case of a circular reference).

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.

KeepCacheOnDeterminantChange (from version 26.07)

Possible values are True or False. By default (False) the Formula follows Futurama’s normal caching behaviour: whenever the value of an object the Formula depends on (a determinant) changes, the cached result of the Formula and of all objects that depend on it is cleared and recalculated.
In some situations this is not desirable, because to preserve a cache you would otherwise have to add the same arguments to every intermediate Formula in the chain purely so the result can be cached at the end.

f the value is True, then the Formula keeps its cached result when one of its determinants changes and instead caches its result on the basis of its own arguments. This makes it possible to add arguments only to the Formula where the cache is actually needed, rather than to every Formula that leads up to it.

The cached result can still be cleared explicitly with a ClearCache object, and is always cleared by an editor or reload Reset.

Note: because values that vary per session are cleared through this same mechanism, any per-session input must be passed to the Formula as an argument rather than relied upon as a determinant.

Caution

Setting the value to true could have negative effects on calculation values if not used correctly. Use the property with care.

NoCache (from version 24.11)

Possible values are True or False. By default Futurama remembers all results of its objects and retrieves them from cache whenever these are requested again unchanged. In some cases however, it is desirable not to cache its result. For performance reasons, if the result of this Formula is solely used by another Formula that caches its result, caching its result would mean using memory that will never be consulted again. If the value is False, then the Formula will use the default method to determine whether its result should be cached. If the value is True, then the Formula will never cache its result.

ReturnsTable (until version 5.0)

This is an automatic property indicating whether the result of the Calculation Object is a table. For a Formula the value depends on the sort of mathematical calculation that is performed. 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. Depending on the Formula that is chosen the Rank is determined. Matrix formula's for example always have Rank=2.  Depending on the rank of the Formula other calculations can be done.

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.

Arguments

If the Formula is to return a value which depends on the value of certain input parameters then these parameters are to be passed to the Formula as arguments. Here these arguments can be defined. See the paragraph Arguments below for more information.

Method

This is an automatic property indicating the operation that is being performed. For example if you have chosen to muliply two numbers it will state 'Multiply'.

Text

Here the Formula can be created and edited. See the paragraph Editing a Formula below for more information. From Futurama version 18.02 it is also possible to define the texts within a ResourceDocument. See the page Text management and Multi-language.

Type

The value of this property determines what kind of values can be entered at the property Text. The following types are available:

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