X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e79727225b9a476b8ce813bf4f1245f25b3f642a..4d02714ee138a3bd9b02e0064b7a2aa26407e9e8:/docs/source/platform_reference.rst diff --git a/docs/source/platform_reference.rst b/docs/source/platform_reference.rst index 77f81e72df..70496ce7af 100644 --- a/docs/source/platform_reference.rst +++ b/docs/source/platform_reference.rst @@ -10,6 +10,8 @@

+.. _platform_reference: + DTD Reference ************* @@ -265,8 +267,26 @@ and a download link. :``state_file``: File containing the state profile. See the full description in :ref:`pf_tag_host` +.. _pf_tag_platform: - +------------------------------------------------------------------ + +------------------------------------------------------------------ + +**Parent tags:** none (this is the root tag of every file) |br| +**Children tags:** :ref:`pf_tag_config` (must come first), +:ref:`pf_tag_cluster`, :ref:`pf_tag_cabinet`, :ref:`pf_tag_peer`, +:ref:`pf_tag_zone`, :ref:`pf_tag_trace`, :ref:`pf_tag_trace_connect` |br| +**Attributes:** + +:``version``: Version of the DTD, describing the whole XML format. + This versionning allow future evolutions, even if we + avoid backward-incompatible changes. The current version + is **4.1**. The ``simgrid_update_xml`` program can + upgrade most of the past platform files to the recent + formalism. + + .. _pf_tag_prop: ------------------------------------------------------------------ @@ -280,7 +300,13 @@ the plugins. From your code, you can interact with these properties using the following functions: + +- Actor: :cpp:func:`simgrid::s4u::Actor::get_property` or :cpp:func:`MSG_process_get_property_value` +- Cluster: this is a zone, see below. - Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value` +- Link: :cpp:func:`simgrid::s4u::Link::get_property` +- Storage: :cpp:func:`simgrid::s4u::Storage::get_property` or :cpp:func:`MSG_storage_get_property_value` +- Zone: :cpp:func:`simgrid::s4u::Zone::get_property` of :cpp:func:`MSG_zone_get_property_value` **Parent tags:** :ref:`pf_tag_actor`, :ref:`pf_tag_config`, :ref:`pf_tag_cluster`, :ref:`pf_tag_host`, :ref:`pf_tag_link`, :ref:`pf_tag_storage`, :ref:`pf_tag_zone` |br|