Home
Categories
Dictionnary
Download
Project Details
Changes Log
Who We Are
FAQ
License

SuperLayer configuration structure


    1  Grammar
    2  cockpit root element
    3  constants
    4  DFFiles
       4.1  cockpitDF
    5  geometry
    6  Type elements
       6.1  Window Types
       6.2  Layout Types
       6.3  Display Types
       6.4  Instanciating a type
       6.5  Overriding a property
    7  Instance elements
       7.1  Cockpit configuration
       7.2  Display element
       7.3  Layout element
       7.4  Window element
    8  Notes

A SuperLayer Windows Configuration contains the following elements:

The following element can only be defined under the config element: The following element can only be defined under the layout or layoutType element: The following element can only be defined under the display or window element:

Grammar

See the Super Layer configuration Schema.

cockpit root element

The cockpit root element allows to define the application ID and Layer ID of the SuperLayer, in the case where you want to allow to change the cockpit layout at runtime.
Example:
      <cockpit appliID="1" layerID="10">  
      ...  
      </cockpit>  

constants

Constants are useful to define only once values that must be reused throughout the configuration. Constants can define a boolean or numeric value.
Example:
      <constants>  
         <constant name="width" value="10000" />  
         <constant name="height" value="10000" />  
      </constants>  
      ...  
      <geometry>  
         <geom name="Window" width="width" height="height" x="0" y="0" />  
      </geometry>  
      <configs border="255,255,255" borderWidth="3">  
         <display id="1" name="simple" width="width" height="height" defaultLayout="layout">  
      ...  
         </display>   
      </configs>             

DFFiles

The DFFiles defines the Definition Files which are used in the cockpit.
By default a df refer to the file defining an XML Definition File, but the type attribute allows to specify explictly the type of the DF file:
Example:
      <DFFiles>  
         <df path="DF1.xml"/>  
         <df path="DF2.xml"/>  
         <df path="DF3.bin" type="binary" />  
      </DFFiles>        

cockpitDF

The cockpitDF child allows to specify the Definition File for the SuperLayer. It is only useful for the client.
Example:
      <DFFiles>  
         <df path="DF1.xml"/>  
         <df path="DF2.xml"/>  
         <cockpitDF path="superlayer.xml" />  
      </DFFiles>  

geometry

The geometry element defines the physical geometry of windows. A window can contain the following elements: Example:
      <geometry>  
         <geom name="Overlay" width="15000" height="10000" transparent="true" />  
         <geom name="WindowFull" width="15000" height="10000"/>  
         <geom name="Window1" width="10000" height="10000"/>        
         <geom name="Window2" width="5000" height="10000" />    
         <geom name="Window3" width="10000" height="5000" />        
         <geom name="Window4" width="10000" height="5000" />         
      </geometry>     

Type elements

Types elements are elements which can be instanciated.

Window Types

The windowTypes element defines the list of window types, which can be instanciated in Layout or Layout types.
A windowType has the following attributes: A windowType can have either: Example for a window type containing Layers:
      <windowType name="Window1" geometry="WindowGeom1" selector="oneOf" >  
         <layer name="Layer3" layerID="3"/>  
         <layer name="Layer4" layerID="4"/>  
      </windowType>    

Example for a window type containing Layouts:
      <windowType name="Window1" geometry="WindowGeom1" defaultLayout="childLayout1">  
         <typeRef type="childLayout1"/>       
         <typeRef type="childLayout2"/>     
      </windowType>   

Layout Types

The layoutTypes element defines the list of layout types, which can be instanciated in the display, display types, window types, or windows.
A layoutType has only one attribute: A layoutType can have either: Example for a layout type containing window types instances:

Display Types

The displayTypes element defines the list of display types, which can be instanciated.
A displayType has the following attributes: A displayType can have either: Example:
      <displayTypes>  
         <displayType name="display" width="15000" height="10000" defaultLayout="layout1">  
            <typeRef type="layout1"/>  
            <typeRef type="layout2"/>  
         </displayType>  
      </displayTypes>    

Instanciating a type

To use a type:

Overriding a property

The override element allows to override the property for an instanced type. The properties wich can be overriden are: A override can have the following attributes: Example:
      <layoutType name="rightInsertLayout">  
         <windowTypeRef name="lowerRight" type="rightinsertWindow" x="24000" y="0">  
            <override>  
               <property name="defaultLayerID" value="81" />  
            </override>                
         </windowTypeRef>  
      </layoutType>        

Another example:
      <typeRef type="dualInsertLayout">   
         <override windowPath="lowerleft">   
            <property name="defaultLayerID" value="81" />   
         </override>              
      </typeRef>              

Instance elements

Cockpit configuration

The configs element defines the cockpit configuration.
The configs element has the following attributes: The configs element only have display children.

Display element

The display element defines one display.
The display element has the following attributes: A display can have either: Example for a display inline instance:
      <configs border="255,255,255" borderWidth="3">  
         <display id="1" name="display" width="15000" height="10000" defaultLayout="layout1">  
            <layout name="layout1">  
               <window name="Window1" >  
                  <layer layerID="5" />                             
               </window>              
            </layout>              
            <layout name="layout2">  
               <window name="Window1" type="oneOf">  
                  <layer layerID="5" />    
                  <layer layerID="6" />                           
               </window>              
            </layout>           
         </display>    
      </configs>  

Example for a display referring to a display type:
      <displayTypes>  
         <displayType name="display" width="15000" height="10000" defaultLayout="layout1">  
            <typeRef type="layout1"/>  
            <typeRef type="layout2"/>  
         </displayType>  
      </displayTypes>     
      <configs border="255,255,255" borderWidth="3">  
         <display id="1" name="display">  
            <typeRef type="display"/>    
         </display>  
      </configs>  

Layout element

The layout element defines one Layout.
A layout has only one attribute: A layout can have either: Example for a Layout inline instance:
     <layout name="layout1">  
        <window name="Window1" >  
           <layer layerID="5" />                             
        </window>              
     </layout>              

Window element

The window element defines one Window.
The window element has the following attributes: A window can have either: Example for a Window inline instance which contains Layers:
      <window name="Window1" type="oneOf">  
         <layer layerID="5" />    
         <layer layerID="6" />                           
      </window>             

Example for a Window inline instance which contains Layouts:
      <window name="Window1" defaultLayout="childLayout1">  
         <layout name="childLayout1">  
      ...                   
         </layout>                 
         <layout name="childLayout2">  
      ...                  
         </layout>                                
      </window>           

Notes

  1. ^ In that case, there is a WindowSelector under the Layer for the Client to select the current Layer
  2. ^ [1] [2] This property can be overriden by each display
  3. ^ [1] [2] [3] [4] [5] It will override the window type value if the window is an instance of a window type
  4. ^ In that case, there is a WindowSelector under the Layer for the Client to select the current Layer

See Also


Categories: cockpit | server | user

Copyright 2016-2017 Dassault Aviation. All Rights Reserved. Documentation and source under the LGPL v2 licence

Project Web Hosted by SourceForge.net Copyright 1999-2010 - Geeknet, Inc., All Rights Reserved About - Legal - Help