Difference between revisions of "Class details"

m (→‎See Also: - removed link that should have been an internal page only)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Attributes]]
 
[[Category:Attributes]]
  
= Attribute Class: Analytica Object Types =
+
== Attribute Class: Analytica Object Types ==
 
 
 
Each object in Analytica has an associated class, which is encoded within its Class attribute.  On an influence diagram, the shape of the object's node reflects its class.
 
Each object in Analytica has an associated class, which is encoded within its Class attribute.  On an influence diagram, the shape of the object's node reflects its class.
  
Line 8: Line 7:
  
 
== Variable Classes ==
 
== Variable Classes ==
 
+
You can change the class of any object in this group, but only to a class also belonging to this group.  For example, you can change a ''Chance'' variable to a ''Decision'', but you can't change a Chance variable to a module.
You can change the class of any object in this group, but only to a class also belonging to this group.  For example, you can change a Chance variable to a Decision, but you can't change a Chance variable to a module.
 
  
 
;Variable: [[Image:Variable node.png]]
 
;Variable: [[Image:Variable node.png]]
Line 24: Line 22:
  
 
;Index: [[Image:IndexNode.jpg]]
 
;Index: [[Image:IndexNode.jpg]]
 +
 +
;Constraint ([[Analytica Optimizer Guide|Optimizer]]): [[Image:ConstraintNode.jpg]]
 +
 +
;Gradient ([[Analytica Optimizer Guide|Optimizer]]): [[Image:GradientNode.jpg]]
  
 
== Module Classes ==
 
== Module Classes ==
Line 40: Line 42:
  
 
== Function Classes ==
 
== Function Classes ==
 
+
;Function: [[User-Defined Function]]  
;Function: [[User-Defined Function]] [[Image:Function node.png]]
+
:[[Image:Function node.png]]
  
 
;SysFunction: Built-in function
 
;SysFunction: Built-in function
Line 48: Line 50:
  
 
== Graphical Object Classes ==
 
== Graphical Object Classes ==
 
 
;Text
 
;Text
  
Line 56: Line 57:
  
 
== Form controls ==
 
== Form controls ==
 
+
;FormNode: An input or output node (created via ''Make Input Node'' or ''Make Output Node'' on the [[Object menu]]. [[Image:Formnode nodes.png]]
;FormNode: An input or output node (created via '''Make Input Node'' or ''Make Output Node'' on the '''Object Menu'''.
 
  
 
;Button: [[Image:Button node.png]]
 
;Button: [[Image:Button node.png]]
  
 
== Non-visible Types ==
 
== Non-visible Types ==
 +
These types may appear in your model, but do not show up visually on an influence diagram.
  
;[[:Category:Attributes|Attribute]]
+
;Attribute: User-Defined Attributes and system defined attributes both are instances of the [[Attributes|Attribute]] class.
  
;[[:Category:Typescript Commands|Command]]
+
;GraphStyleTemplate: These are defined from the graph setup dialog, and are used to package common graph style settings. 
  
;GraphStyleTemplate
+
== System types ==
 +
;Attribute
 +
 
 +
;Command
  
 
;Keyword
 
;Keyword
  
;Object:Every Analytica object has a class -- one of the labels listed on this page.  The classes themselves exist as Analytica objects, each of them having the class ''Object''.
+
;Object:Every Analytica object has a class -- one of the labels listed on this page.  The classes themselves exist as Analytica objects, each of them having the class [[Object]].
  
 
;SysVar
 
;SysVar
  
 
== Internal use only ==
 
== Internal use only ==
 
+
The classes in this section are not directly usable as a modeler in Analytica.  They are either placeholders for future features, deprecated features, or features used only internally by Analytica.
The classes in this section are not directly usable as a modeler in Analytica.  They are either placeholders for future features, depreciated features, or features unsed only internally by Analytica.
 
  
 
;ActiveX
 
;ActiveX
Line 84: Line 87:
 
;Version
 
;Version
  
= Listing all objects of a given =
+
== Listing all objects of a given ==
 +
From [[typescript]], you can obtain a listing of all object classes by typing:
  
From typescript, you can obtain a listing of all object classes by typing:
+
:<code>List Object</code>
  
List Object
+
You can also list all objects that have an indicated class using the [[List]] command, e.g., the following shows all decision variables:
  
You can also list all objects that have an indicated class using the [[List]] command, e.g., the following shows all decision variables:
+
:<code>List Decision</code>
  
List Decision
+
==See Also==
 +
* [[Classes of variables and other objects]]
 +
* [[Change class of an object]]
 +
* [[Objects and Values]]
 +
* [[Attributes]]
 +
* [[Identifier]]
 +
* [[Typescript]]
 +
* [[List]]

Latest revision as of 19:20, 5 July 2024


Attribute Class: Analytica Object Types

Each object in Analytica has an associated class, which is encoded within its Class attribute. On an influence diagram, the shape of the object's node reflects its class.

An object in Analytica is an entity that has a class, an identifier and attribute values. Simple values like numbers and text values are not Analytica objects, so they do not have an associated class, nor do they have attribute values. Also, local variables are not objects (and thus, have no attributes). But most other things in Analytica are objects, and thus have an associated class. You can examine the class of any object by looking at its class attribute.

Variable Classes

You can change the class of any object in this group, but only to a class also belonging to this group. For example, you can change a Chance variable to a Decision, but you can't change a Chance variable to a module.

Variable
Variable node.png
Decision
Decision Node.png
Chance
Chance node.png
Objective
Objective node.png
Constant
Constant node.png
Determ
Determ node.png
Index
IndexNode.jpg
Constraint (Optimizer)
ConstraintNode.jpg
Gradient (Optimizer)
GradientNode.jpg

Module Classes

Module
Module node.png
LinkModule
LinkModule node.png
Model
Library
Library node.png
LinkLibrary
LinkLibrary node.png
Form

Function Classes

Function
User-Defined Function
Function node.png
SysFunction
Built-in function
PluginFunction

Graphical Object Classes

Text
Picture
Alias

Form controls

FormNode
An input or output node (created via Make Input Node or Make Output Node on the Object menu. Formnode nodes.png
Button
Button node.png

Non-visible Types

These types may appear in your model, but do not show up visually on an influence diagram.

Attribute
User-Defined Attributes and system defined attributes both are instances of the Attribute class.
GraphStyleTemplate
These are defined from the graph setup dialog, and are used to package common graph style settings.

System types

Attribute
Command
Keyword
Object
Every Analytica object has a class -- one of the labels listed on this page. The classes themselves exist as Analytica objects, each of them having the class Object.
SysVar

Internal use only

The classes in this section are not directly usable as a modeler in Analytica. They are either placeholders for future features, deprecated features, or features used only internally by Analytica.

ActiveX
ExcelWorkbook
LocalVar
Version

Listing all objects of a given

From typescript, you can obtain a listing of all object classes by typing:

List Object

You can also list all objects that have an indicated class using the List command, e.g., the following shows all decision variables:

List Decision

See Also

Comments


You are not allowed to post comments.