Portal Attribute: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__FORCETOC__
__FORCETOC__ A Sub-system can possess its own Attributes. These attributes are stored with the Portal that contains the subsystem, hence the term “Portal Attribute”.  
A Sub-system can possess its own Attributes. These attributes are stored with the Portal that contains the subsystem, hence the term “Portal Attribute”.


<onlyinclude>Portal Attributes enable modular models to be built since their Attributes are only used within the sub-system concerned. Portal Attributes get copied and pasted along with the Portal. Portal Attributes can be accessed and edited from the Portal Object's Edit Menu, or the Portal Entry inside the sub-system itself. They are also visible and available for editing and referencing from any subsystem within the portal at which they are defined, when the Portal Attributes option under Data in the Menu Bar is selected.</onlyinclude>
<onlyinclude>Portal Attributes enable modular models to be built since their Attributes are only used within the sub-system concerned. Portal Attributes get copied and pasted along with the Portal. Portal Attributes can be accessed and edited from the Portal Object's Edit Menu, or the Portal Entry inside the sub-system itself. They are also visible and available for editing and referencing from any subsystem within the portal at which they are defined, when the Portal Attributes option under Data in the Menu Bar is selected.</onlyinclude>  


Portal Attributes are created and selected in the Portal Attribute List in the same manner as other Attributes.
Portal Attributes are created and selected in the Portal Attribute List in the same manner as other Attributes.  


“Views” of Portal Attributes are available and can be logged. These Attribute Views are created by clicking the Add View button in the Attribute Edit Dialog.
“Views” of Portal Attributes are available and can be logged. These Attribute Views are created by clicking the Add View button in the Attribute Edit Dialog.  


The View for a Portal Attribute can be put within the sub-system or it can be placed on the same screen as the Portal.
The View for a Portal Attribute can be put within the sub-system or it can be placed on the same screen as the Portal.  


==Encapsulation of Portal Attributes==
== Encapsulation of Portal Attributes ==
Portal Attributes apply only locally within the subsystem that owns them. Encapsulating model behaviour into a sub-system is easier and more convenient if you use Portal Attributes.


When you encapsulate the Portal’s behavioural settings, copying and pasting that Portal gives two independent sub-systems. Each has their own separate set of attributes, and retain their own internal integrity without the model having to be edited.
Portal Attributes apply only locally within the subsystem that owns them. Encapsulating model behaviour into a sub-system is easier and more convenient if you use Portal Attributes.  


All sub-systems below the current sub-system can " see " the attributes of the current sub-system, unless they possess their own attribute of the same name.
When you encapsulate the Portal’s behavioural settings, copying and pasting that Portal gives two independent sub-systems. Each has their own separate set of attributes, and retain their own internal integrity without the model having to be edited.  


If a reference to a Portal Attribute is not resolved, the Portal Hierarchy is searched upwards for an attribute of the same name.
All sub-systems below the current sub-system can " see " the attributes of the current sub-system, unless they possess their own attribute of the same name.
 
If a reference to a Portal Attribute is not resolved, the Portal Hierarchy is searched upwards for an attribute of the same name.  
 
== Portal Attribute Creation and Selection ==


==Portal Attribute Creation and Selection==
{|
{|
| [[Image:portal_data.jpg|left]]
|-
|Click on a Portal and select Portal Attributes from the Data Option Flyout.
| [[Image:Portal data.jpg|left]]  
| Click on a Portal and select Portal Attributes from the Data Option Flyout.
|}
|}


{|
{|
| [[Image:portal_attributes_main.jpg|left]]
|-
|Attributes already present are then displayed in a list, along with their initial values.
| [[Image:Portal attributes main.jpg|left]]  
| Attributes already present are then displayed in a list, along with their initial values.  
<br> Right Click to select a Portal Attribute to be edited


Right Click to select a Portal Attribute to be edited
|}
|}


{|
{|
| [[Image:portal_attributes_buttons.jpg|left]]
|-
|or Click the Add Attribute button to create a new Portal Attribute.
| [[Image:Portal attributes buttons.jpg|left]]  
| or Click the Add Attribute button to create a new Portal Attribute.
|}
|}


==Fields, Settings and Buttons==
== Fields, Settings and Buttons ==
These are the fields, settings and buttons that are available when creating or editing Portal Attributes.
 
These are the fields, settings and buttons that are available when creating or editing Portal Attributes.  


{| border="1"
{| border="1"
|+Fields
|+ Fields  
!Field/Setting  !! Description
|-
|-
|Name
! Field/Setting
|Enter/Edit the Name of the Attribute.
! Description
|-
|-
|Comment
| Name
|Enter/Edit an optional comment, to guide those who come after you.
| Enter/Edit the Name of the Attribute.
|-
|-
|Initial Value
| Comment
|Enter/Edit the value applied to this Attribute upon the model being loaded.
| Enter/Edit an optional comment, to guide those who come after you.
|-
|-
|Units
| Initial Value
|Select a Display format for this Attribute.
| Enter/Edit the value applied to this Attribute upon the model being loaded.
|-
| Units  
| Select a Display format for this Attribute.
|}
|}


{| border="1"
{| border="1"
|+Option Settings
|+ Option Settings  
|Clear Contents at Start
|The Attribute's Clear Value will be applied to the Attribute at the beginning of each run.
|-
|Clear Value
|The value applied to the Attribute whenever its contents are cleared (at Run Start or via an Operation in a routine).
|-
|Constant During Run
|Specifies a condition that the Attribute can only be Read, and not be written to, during a run. An attempt to alter the value of this attribute will be detected and produce a run time error. This speeds up comparisons, and detects model errors where the "constant" may be accidentally modified.
|-
|Retain on Paste Replace
|If the Attribute's owning Portal is targeted in a Paste/Replace operation, this attribute is not updated.
|-
|-
|Round Values to Integers
| Clear Contents at Start
|Rounding will be applied to any alterations of this Attribute, ensuring that whole integer values are always experienced.
| The Attribute's Clear Value will be applied to the Attribute at the beginning of each run.
|-
|-
|Edits Don't Set Modified Bit
| Clear Value
|If this attribute's value is altered, the model will not consider that it has been modified, and prompt to be saved.
| The value applied to the Attribute whenever its contents are cleared (at Run Start or via an Operation in a routine).
|-
|-
|Enable Range Checking
| Constant During Run
|Provides a bounds checking feature for the Attribute's value. If breakpoints are enabled, going beyond the range limits will cause a breakpoint. If breakpoints are disabled, going out of range will trigger a run time error, and stop the run.
| Specifies a condition that the Attribute can only be Read, and not be written to, during a run. An attempt to alter the value of this attribute will be detected and produce a run time error. This speeds up comparisons, and detects model errors where the "constant" may be accidentally modified.
|-
|-
|Lower Limit
| Retain on Paste Replace
|Below this value is out of range.
| If the Attribute's owning Portal is targeted in a Paste/Replace operation, this attribute is not updated.
|-
|-
|Upper Limit
| Edits Don't Set Modified Bit
|Above this value is out of range.
| If this attribute's value is altered, the model will not consider that it has been modified, and prompt to be saved.
|}
|}


{| border="1"
{| border="1"
|+Buttons
|+ Buttons  
|Data Set
|-
|Select which [[DataSet_(Scenario)|Datasets]] to make this attribute a member of so it is saved when those datasets are saved. This refers to the original scenario dataset system not [[DataSet|Dataset 2.0]]
| Data Set  
|-valign="top"
| Select which [[DataSet (Scenario)|Datasets]] to make this attribute a member of so it is saved when those datasets are saved. This refers to the original scenario dataset system not [[DataSet|Dataset 2.0]]
|Attribute
|- valign="top"
|Displays a Menu of Options
| Attribute  
;Show References
| Displays a Menu of Options  
:Displays a References list showing (if relevant): Source Object; Location; Modified Flag; Reference; Routine Line Number; Routine Operation. Right Click on a Source to switch to that object's panel and have it highlighted by a flashing box.
;Show References  
;Go To Owner
:Displays a References list showing (if relevant): Source Object; Location; Modified Flag; Reference; Routine Line Number; Routine Operation. Right Click on a Source to switch to that object's panel and have it highlighted by a flashing box.  
:Displays the Subsystem whose Portal Scope this attribute is defined at.
;Go To Owner  
;Migrate to Owner
:Displays the Subsystem whose Portal Scope this attribute is defined at.  
:Shift the Scope of the Attribute up one level, to the owning subsystem.
;Migrate to Owner  
;Add To Data Object List
:Shift the Scope of the Attribute up one level, to the owning subsystem.  
;Add To Data Object List  
:Creates a data object label, this enables the attribute to be referenced and saved in a [[DataSet|Dataset 2.0]] file
:Creates a data object label, this enables the attribute to be referenced and saved in a [[DataSet|Dataset 2.0]] file
|-valign="top"
 
|Add View
|- valign="top"
|Adds a View of this Attribute to the currently visible Panel.
| Add View  
|-valign="top"
| Adds a View of this Attribute to the currently visible Panel.
|Remove
|- valign="top"
|Deletes the Attribute. Warns if any references exist for this Attribute.
| Remove  
| Deletes the Attribute. Warns if any references exist for this Attribute.
|}
|}


[[Category:Attribute]]
[[Category:Attribute]] [[Category:Object/Portal]]
[[Category:Object/Portal]]

Revision as of 13:43, 9 March 2009

A Sub-system can possess its own Attributes. These attributes are stored with the Portal that contains the subsystem, hence the term “Portal Attribute”.

Portal Attributes enable modular models to be built since their Attributes are only used within the sub-system concerned. Portal Attributes get copied and pasted along with the Portal. Portal Attributes can be accessed and edited from the Portal Object's Edit Menu, or the Portal Entry inside the sub-system itself. They are also visible and available for editing and referencing from any subsystem within the portal at which they are defined, when the Portal Attributes option under Data in the Menu Bar is selected.

Portal Attributes are created and selected in the Portal Attribute List in the same manner as other Attributes.

“Views” of Portal Attributes are available and can be logged. These Attribute Views are created by clicking the Add View button in the Attribute Edit Dialog.

The View for a Portal Attribute can be put within the sub-system or it can be placed on the same screen as the Portal.

Encapsulation of Portal Attributes

Portal Attributes apply only locally within the subsystem that owns them. Encapsulating model behaviour into a sub-system is easier and more convenient if you use Portal Attributes.

When you encapsulate the Portal’s behavioural settings, copying and pasting that Portal gives two independent sub-systems. Each has their own separate set of attributes, and retain their own internal integrity without the model having to be edited.

All sub-systems below the current sub-system can " see " the attributes of the current sub-system, unless they possess their own attribute of the same name.

If a reference to a Portal Attribute is not resolved, the Portal Hierarchy is searched upwards for an attribute of the same name.

Portal Attribute Creation and Selection

Portal data.jpg
 Click on a Portal and select Portal Attributes from the Data Option Flyout.
Portal attributes main.jpg
 Attributes already present are then displayed in a list, along with their initial values.


Right Click to select a Portal Attribute to be edited

Portal attributes buttons.jpg
 or Click the Add Attribute button to create a new Portal Attribute.

Fields, Settings and Buttons

These are the fields, settings and buttons that are available when creating or editing Portal Attributes.

Fields
Field/Setting Description
Name Enter/Edit the Name of the Attribute.
Comment Enter/Edit an optional comment, to guide those who come after you.
Initial Value Enter/Edit the value applied to this Attribute upon the model being loaded.
Units Select a Display format for this Attribute.
Option Settings
Clear Contents at Start The Attribute's Clear Value will be applied to the Attribute at the beginning of each run.
Clear Value The value applied to the Attribute whenever its contents are cleared (at Run Start or via an Operation in a routine).
Constant During Run Specifies a condition that the Attribute can only be Read, and not be written to, during a run. An attempt to alter the value of this attribute will be detected and produce a run time error. This speeds up comparisons, and detects model errors where the "constant" may be accidentally modified.
Retain on Paste Replace If the Attribute's owning Portal is targeted in a Paste/Replace operation, this attribute is not updated.
Edits Don't Set Modified Bit If this attribute's value is altered, the model will not consider that it has been modified, and prompt to be saved.
Buttons
Data Set Select which Datasets to make this attribute a member of so it is saved when those datasets are saved. This refers to the original scenario dataset system not Dataset 2.0
Attribute Displays a Menu of Options
Show References
Displays a References list showing (if relevant): Source Object; Location; Modified Flag; Reference; Routine Line Number; Routine Operation. Right Click on a Source to switch to that object's panel and have it highlighted by a flashing box.
Go To Owner
Displays the Subsystem whose Portal Scope this attribute is defined at.
Migrate to Owner
Shift the Scope of the Attribute up one level, to the owning subsystem.
Add To Data Object List
Creates a data object label, this enables the attribute to be referenced and saved in a Dataset 2.0 file
Add View Adds a View of this Attribute to the currently visible Panel.
Remove Deletes the Attribute. Warns if any references exist for this Attribute.
Retrieved from ‘https://wiki.planimate.com/index.php?title=Portal_Attribute&oldid=3079’