src/Plugins/MedReader/ParaViewPlugin/Resources/MedReaderServer.xml

   1 <ServerManagerConfiguration>
   2   <ProxyGroup
   3     name="sources">
   4     <SourceProxy
   5       name="MedReader"
   6       class="vtkMedReader"
   7       label="MED Reader">
   8
   9       <StringVectorProperty
  10         name="FileName"
  11         command="SetFileName"
  12         number_of_elements="1"
  13         animateable="0">
  14         <FileListDomain
  15           name="files" />
  16         <Documentation>
  17           This property specifies the file name for the MED reader.
  18         </Documentation>
  19       </StringVectorProperty>
  20
  21       <StringVectorProperty
  22         name="CellFieldsArrayInfo"
  23         information_only="1">
  24         <ArraySelectionInformationHelper
  25           attribute_name="CellField" />
  26       </StringVectorProperty>
  27
  28       <StringVectorProperty
  29         name="CellFieldsArrayStatus"
  30         command="SetCellFieldArrayStatus"
  31         label="Cell Arrays"
  32         number_of_elements="0"
  33         repeat_command="1"
  34         number_of_elements_per_command="2"
  35         element_types="2 0"
  36         information_property="CellFieldsArrayInfo">
  37         <ArraySelectionDomain
  38           name="array_list">
  39           <RequiredProperties>
  40             <Property
  41               name="CellFieldsArrayInfo"
  42               function="ArrayList" />
  43           </RequiredProperties>
  44         </ArraySelectionDomain>
  45         <Documentation>
  46           This property lists which cell-centered arrays to read.
  47        </Documentation>
  48       </StringVectorProperty>
  49
  50       <StringVectorProperty
  51         name="PointFieldsArrayInfo"
  52         information_only="1">
  53         <ArraySelectionInformationHelper
  54           attribute_name="PointField" />
  55       </StringVectorProperty>
  56
  57       <StringVectorProperty
  58         name="PointFieldsArrayStatus"
  59         command="SetPointFieldArrayStatus"
  60         number_of_elements="0"
  61         repeat_command="1"
  62         number_of_elements_per_command="2"
  63         element_types="2 0"
  64         information_property="PointFieldsArrayInfo"
  65         label="Point Arrays">
  66         <ArraySelectionDomain
  67           name="array_list">
  68           <RequiredProperties>
  69             <Property
  70               name="PointFieldsArrayInfo"
  71               function="ArrayList" />
  72           </RequiredProperties>
  73         </ArraySelectionDomain>
  74         <Documentation>
  75           This property lists which point-centered arrays to read.
  76        </Documentation>
  77       </StringVectorProperty>
  78
  79       <StringVectorProperty
  80         name="QuadratureFieldsArrayInfo"
  81         information_only="1">
  82         <ArraySelectionInformationHelper
  83           attribute_name="QuadratureField" />
  84       </StringVectorProperty>
  85
  86       <StringVectorProperty
  87         name="QuadratureFieldsArrayStatus"
  88         command="SetQuadratureFieldArrayStatus"
  89         number_of_elements="0"
  90         repeat_command="1"
  91         number_of_elements_per_command="2"
  92         element_types="2 0"
  93         information_property="QuadratureFieldsArrayInfo"
  94         label="Quadrature Point Arrays">
  95         <ArraySelectionDomain
  96           name="array_list">
  97           <RequiredProperties>
  98             <Property
  99               name="QuadratureFieldsArrayInfo"
 100               function="ArrayList" />
 101           </RequiredProperties>
 102         </ArraySelectionDomain>
 103         <Documentation>
 104           This property lists which integration-point-centered arrays to read.
 105        </Documentation>
 106       </StringVectorProperty>
 107
 108       <StringVectorProperty
 109         name="ElnoFieldsArrayInfo"
 110         information_only="1">
 111         <ArraySelectionInformationHelper
 112           attribute_name="ElnoField" />
 113       </StringVectorProperty>
 114
 115       <StringVectorProperty
 116         name="ElnoFieldsArrayStatus"
 117         command="SetElnoFieldArrayStatus"
 118         number_of_elements="0"
 119         repeat_command="1"
 120         number_of_elements_per_command="2"
 121         element_types="2 0"
 122         information_property="ElnoFieldsArrayInfo"
 123         label="Elno Point Arrays">
 124         <ArraySelectionDomain
 125           name="array_list">
 126           <RequiredProperties>
 127             <Property
 128               name="ElnoFieldsArrayInfo"
 129               function="ArrayList" />
 130           </RequiredProperties>
 131         </ArraySelectionDomain>
 132         <Documentation>
 133           This property lists which integration-point-centered arrays to read.
 134        </Documentation>
 135       </StringVectorProperty>
 136
 137       <StringVectorProperty
 138         name="Entity"
 139         label="Entity"
 140         command="SetEntityStatus"
 141         number_of_elements="2"
 142         repeat_command="1"
 143         number_of_elements_per_command="2"
 144         element_types="2 0"
 145         information_property="EntityInfo">
 146         <SILDomain
 147           name="array_list"
 148           subtree="Entity">
 149           <RequiredProperties>
 150             <Property
 151               name="EntityInfo"
 152               function="ArrayList" />
 153           </RequiredProperties>
 154         </SILDomain>
 155         <Hints>
 156           <!--
 157             This overrides the GUI's default mechanism to not set the default value for this property using the domain
 158             when the proxy is created
 159           -->
 160           <NoDefault />
 161         </Hints>
 162         <Documentation>
 163           This property can be used to select the cell types to load.
 164           Example : ['MED_CELL/MED_TRIA3']
 165         </Documentation>
 166       </StringVectorProperty>
 167
 168       <StringVectorProperty
 169         name="EntityInfo"
 170         information_only="1">
 171         <SILInformationHelper
 172           timestamp_command="GetSILUpdateStamp"
 173           subtree="Entity">
 174         </SILInformationHelper>
 175       </StringVectorProperty>
 176
 177       <StringVectorProperty
 178         name="Groups"
 179         label="Groups"
 180         command="SetGroupStatus"
 181         number_of_elements="2"
 182         repeat_command="1"
 183         number_of_elements_per_command="2"
 184         element_types="2 0"
 185         information_property="GroupInfo">
 186         <MedGroupSelectionDomain
 187           name="array_list"
 188           subtree="Groups">
 189           <RequiredProperties>
 190             <Property
 191               name="GroupInfo"
 192               function="ArrayList" />
 193           </RequiredProperties>
 194         </MedGroupSelectionDomain>
 195         <Documentation>
 196           Set the groups on cells to be loaded.
 197           Example : SetGroups(['GROUP/MAILLAGE/OnCell/GROUP_NAME',
 198             'GROUP/MAILLAGE/OnPoints/GROUP_NAME']).
 199         </Documentation>
 200       </StringVectorProperty>
 201
 202       <StringVectorProperty
 203         name="GroupInfo"
 204         information_only="1">
 205         <SILInformationHelper
 206           timestamp_command="GetSILUpdateStamp"
 207           subtree="Groups">
 208         </SILInformationHelper>
 209       </StringVectorProperty>
 210
 211       <IntVectorProperty
 212         name="SILUpdateStamp"
 213         command="GetSILUpdateStamp"
 214         information_only="1">
 215         <SimpleIntInformationHelper />
 216         <Documentation>
 217           Information property indicating the update stamp of the SIL. Every
 218           time the SIL is rebuild, this
 219           time stamp is changed.
 220         </Documentation>
 221       </IntVectorProperty>
 222
 223       <IntVectorProperty
 224         name="AnimationMode"
 225         command="SetAnimationMode"
 226         number_of_elements="1"
 227         default_values="0">
 228         <EnumerationDomain
 229           name="enum">
 230           <Entry value="0" text="Default" />
 231           <Entry value="1" text="Times" />
 232           <Entry value="2" text="Iterations" />
 233           <Entry value="3" text="Modes" />
 234         </EnumerationDomain>
 235         <Documentation>
 236           The animation modes defines how the animation controls of ParaView
 237           browse the computing steps available in the med file.
 238           Default : It is the same as "Times" if there is any time defined
 239           in the med file.
 240           It is the same as "Iteration" if there is no times but iterations.
 241           Times : The reader advertise the availbale times in the med file.
 242           If there are multiple iterations for a given time,
 243           the reader will load the last one.
 244           Iterations : You also have to specify the TimeIndexForIterations
 245           parameter. The reader will then advertise iterations at the given
 246           time index.
 247           Modes : This mode is made for modal analysis post-processing : all
 248           selected frequencies (use the FrequencyArrayStatus property)
 249           are loaded so that the user can easily switch from
 250           a frequency to another.
 251           The reader reports no time but a time range of -PI/PI.
 252         </Documentation>
 253       </IntVectorProperty>
 254
 255       <DoubleVectorProperty
 256         name="AvailableTimes"
 257         command="GetAvailableTimes"
 258         number_of_elements="2"
 259         default_values="0 0"
 260         information_only="1">
 261         <DoubleArrayInformationHelper />
 262       </DoubleVectorProperty>
 263
 264       <IntVectorProperty
 265         name="TimeIndexForIterations"
 266         command="SetTimeIndexForIterations"
 267         number_of_elements="1"
 268         default_values="0.0">
 269       </IntVectorProperty>
 270
 271       <DoubleVectorProperty
 272         name="TimestepValues"
 273         repeatable="1"
 274         information_only="1">
 275         <TimeStepsInformationHelper />
 276         <Documentation>
 277           Available timestep values.
 278         </Documentation>
 279       </DoubleVectorProperty>
 280
 281       <StringVectorProperty
 282         name="FrequencyArrayInfo"
 283         information_only="1">
 284         <ArraySelectionInformationHelper
 285           attribute_name="Frequency" />
 286       </StringVectorProperty>
 287
 288       <StringVectorProperty
 289         name="FrequencyArrayStatus"
 290         command="SetFrequencyArrayStatus"
 291         number_of_elements="0"
 292         repeat_command="1"
 293         number_of_elements_per_command="2"
 294         element_types="2 0"
 295         information_property="FrequencyArrayInfo"
 296         label="Frequencies">
 297         <ArraySelectionDomain
 298           name="array_list">
 299           <RequiredProperties>
 300             <Property
 301               name="FrequencyArrayInfo"
 302               function="ArrayList" />
 303           </RequiredProperties>
 304         </ArraySelectionDomain>
 305         <Documentation>
 306           This property lists which frequencies are in the med file for
 307           modal analysis.
 308        </Documentation>
 309       </StringVectorProperty>
 310
 311       <IntVectorProperty
 312         name="CacheStrategy"
 313         command="SetCacheStrategy"
 314         number_of_elements="1"
 315         default_values="2">
 316         <EnumerationDomain name="enum">
 317           <Entry value="0" text="Nothing" />
 318           <Entry value="1" text="Geometry" />
 319           <Entry value="2" text="All" />
 320         </EnumerationDomain>
 321         <Documentation>
 322           Set the strategy to cache data read from the disk.
 323           0 : Nothing. The reader tries to minimize the memory footprint,
 324             but will read data very often from the disk. Choose this if your
 325             dataset is large and memory is an issue.
 326           1 : Geometry. The reader will cache the geometry, but not field
 327             values. A each time change, field values will be re-read from
 328             disk. Good if your dataset fits in memory but not your time steps.
 329           2 : All (Default). The reader will keep all the geometry and fields
 330             read from disk over time. Choose this if memory is not an issue.
 331         </Documentation>
 332       </IntVectorProperty>
 333
 334       <IntVectorProperty
 335         name="GenerateVectors"
 336         command="SetGenerateVectors"
 337         number_of_elements="1"
 338         default_values="1">
 339         <BooleanDomain name="bool"/>
 340         <Documentation>
 341           If this flag is set, the reader will generate a vector field for
 342           each field in the file that has 2 or more components.
 343           If the field has 2 components, a third compoenent with the value
 344           0 will be added.
 345           If the field has more than 3 components, the first 3 components will
 346           be extracted.
 347         </Documentation>
 348       </IntVectorProperty>
 349
 350     </SourceProxy>
 351   </ProxyGroup>
 352
 353   <ProxyGroup
 354     name="filters">
 355     <SourceProxy
 356       name="ExtractGroup"
 357       class="vtkExtractGroup"
 358       label="Extract Group">
 359
 360      <InputProperty
 361         name="Input"
 362         command="SetInputConnection">
 363            <ProxyGroupDomain name="groups">
 364              <Group name="sources"/>
 365              <Group name="filters"/>
 366            </ProxyGroupDomain>
 367            <DataTypeDomain name="input_type">
 368              <DataType value="vtkMultiBlockDataSet"/>
 369            </DataTypeDomain>
 370            <Documentation>
 371              This property specifies the input to the Level Scalars filter.
 372            </Documentation>
 373      </InputProperty>
 374
 375       <StringVectorProperty
 376         name="Entity"
 377         label="Cell Type"
 378         command="SetEntityStatus"
 379         number_of_elements="2"
 380         repeat_command="1"
 381         number_of_elements_per_command="2"
 382         element_types="2 0"
 383         information_property="EntityInfo">
 384         <SILDomain
 385           name="array_list"
 386           subtree="Entity">
 387           <RequiredProperties>
 388             <Property name="EntityInfo" function="ArrayList" />
 389           </RequiredProperties>
 390         </SILDomain>
 391         <Hints>
 392           <!--
 393             This overrides the GUI's default mechanism to not set the default
 394             value for this property using the domain
 395             when the proxy is created
 396           -->
 397           <NoDefault />
 398         </Hints>
 399         <Documentation>
 400           This property can be used to select the cell types to load.
 401           Example : ['MED_MAILLE/MED_TRIA3']
 402         </Documentation>
 403       </StringVectorProperty>
 404
 405       <StringVectorProperty
 406         name="EntityInfo"
 407         information_only="1">
 408         <SILInformationHelper
 409           timestamp_command="GetSILUpdateStamp"
 410           subtree="Entitys">
 411         </SILInformationHelper>
 412       </StringVectorProperty>
 413
 414       <StringVectorProperty
 415         name="Groups"
 416         label="Groups"
 417         command="SetGroupStatus"
 418         number_of_elements="2"
 419         repeat_command="1"
 420         number_of_elements_per_command="2"
 421         element_types="2 0"
 422         information_property="GroupInfo">
 423         <MedGroupSelectionDomain
 424           name="array_list"
 425           subtree="Groups">
 426           <RequiredProperties>
 427             <Property name="GroupInfo" function="ArrayList" />
 428           </RequiredProperties>
 429         </MedGroupSelectionDomain>
 430
 431         <Documentation>
 432           Set the groups on cells to be loaded.
 433           Example : SetGroups(['GROUP/MAILLAGE/OnCell/GROUP_NAME',
 434             'GROUP/MAILLAGE/OnPoints/GROUP_NAME']).
 435         </Documentation>
 436       </StringVectorProperty>
 437
 438       <StringVectorProperty
 439         name="GroupInfo"
 440         information_only="1">
 441         <SILInformationHelper
 442           timestamp_command="GetSILUpdateStamp"
 443           subtree="Groups">
 444         </SILInformationHelper>
 445       </StringVectorProperty>
 446
 447       <IntVectorProperty
 448         name="SILUpdateStamp"
 449         command="GetSILUpdateStamp"
 450         information_only="1">
 451         <SimpleIntInformationHelper />
 452         <Documentation>
 453           Information property indicating the update stamp of the SIL. Every
 454           time the SIL is rebuild, this
 455           time stamp is changed.
 456         </Documentation>
 457       </IntVectorProperty>
 458
 459       <IntVectorProperty
 460         name="PruneOutput"
 461         command="SetPruneOutput"
 462         number_of_elements="1"
 463         default_values="1">
 464         <BooleanDomain name="bool" />
 465         <Documentation>
 466           If set to true, this filter will prune the empty parts in the output.
 467           If not, empty datasets will be kept.
 468         </Documentation>
 469       </IntVectorProperty>
 470
 471     </SourceProxy>
 472     <SourceProxy
 473       name="GenerateStructuralElement"
 474       class="vtkGenerateStructElement"
 475       label="Generate Structural Element">
 476
 477      <InputProperty
 478         name="Input"
 479         command="SetInputConnection">
 480            <ProxyGroupDomain name="groups">
 481              <Group name="sources"/>
 482              <Group name="filters"/>
 483            </ProxyGroupDomain>
 484            <DataTypeDomain name="input_type">
 485              <DataType value="vtkUnstructuredGrid"/>
 486            </DataTypeDomain>
 487            <Documentation>
 488              This property specifies the input to the Generate Structural Element filter.
 489            </Documentation>
 490      </InputProperty>
 491
 492     </SourceProxy>
 493   </ProxyGroup>
 494 </ServerManagerConfiguration>