ALPHA-VISION® Bdc: MarkDamageLimits

MarkDamageLimits

SUMMARY

Marking of damage limits

SYNTAX

MarkDamageLimits(<class, affliction_type, context_figure, cur_file>);

ARGUMENTS

class (type:string)

The user defined Data-Object class administering the damage data. On clicking to it an instance of that class is created.

Such a class must have the following properties:

• ContextFigure (String)
  The name of the figure for the context menu of the damage. The value is taken from the according argument of the MarkDamageLimits-Jobs.
• Display (String)
  The name of the picture the border polygons were placed in.
• SectionPolyName (String)
  The name of the selected section polygon. This value is handled internally.
• Section (String)
  The name of the section the damage occurred. This value is handled internally.
• DamageType
  This value is taken from the affliction_type argument of the MarkDamageLimits-Jobs.
• LBorderPolyName (String) resp. RBorderPolyName (String)
  The name of the left-sided resp. right-sided border polygon. This value is handled internally.
• LPotL (bool)
  Flag for a damage according the affliction_type left of the left border polygon, i.e. in the left adjacent section. This value is handled internally.
• LPotR (bool)
  Flag for a damage according the affliction_type right of the left border polygon. This value is handled internally.
• RPotL (bool)
  Flag for a damage according the affliction_type left of the right border polygon, i.e. in the selected section. This value is handled internally.
• RPotR (bool)
  Flag for a damage according the affliction_type right of the right border polygon. This value is handled internally.
• Created (time)
  The time is automatically set on placing the symbol.

The Data-Object of the actual selected damage can be addresses via BDC.ActDamage.

affliction_type (type:string)

The damage type in the afflicted section.

There are 3 types of affliction:

• Fire - catches hold of smoke borders
• Water - catches hold of flood borders
• ABC - catches hold of contamination borders
  This text is stored in the property ‘DamageType’ of the damage Data-Object and serves to draw the section after a picture change.

context_figure (type:string)

The figure (only the name, not the file) for the Context Menu. This text is saved to the property ‘ContextFigure’ of the damage Data-Object and is used to switch the figure for the Context Menu.

cur_file (type:string)

The file name for the cursor to display relative to the project folder. The file must be found in the project folder or a subdirectory to it. It is possible to have animated cursors.

DESCRIPTION

The mouse pointer turns into the defined cursor. Now the user may click into a room of the BDCRUN-Application in the right window. Hereupon for that section an according affliction_type flag is set.
In addition the flags of the border polygons for that affliction_type are adapted the following way:

• Clicking to a section with already active borders.
  With the appropriate settings the context menu belonging to these borders is shown.
• Clicking to a section with no active borders, but aside one with active borders.
  The border between these to sections are moved to the edge of the clicked section.
• Clicking to a section without active borders.
  The borders for these section are activated.

By querying the section side of the border polygon and the 'affliction_type' dependent flags (see border polygon) in the refresh script the color and fill pattern switching is realised.

EXAMPLES

Icon (Button) in icon Ibar: (Action)

//The cursor is found in the subdirectory Cursors
MarkDamageLimits("DamageLim", "Fire", "DamageLimCont", "Cursors\FireLim.cur");

Places the figure for the Context Menu: (Refresh)

SetVal(Figure, BDC.ActDamage.ContextFigure);

Grafic Objects within the Context Menu Figure:
e.g. Displays the damage type in a text: (Refresh)

SetVal(Text, BDC.ActDamage.DamageType);

---

Syntax Notation

[aaa]

aaa is optional (zero or one occurences)

(aaa|bbb)

aaa exclusive or bbb

(aaa)*

aaa may occur indefinitely often or may be omitted

(aaa)+

aaa may occur indefinitely often but at least once

(aaa)m..n

aaa may occur from m to n times