Merge pull request #66 from tango-controls/TD-UpdateOverview (8fbaccc5) · Commits · tango-controls / tango-doc

source/overview/SimplifiedTangoDatamodel.rst

+34 −35

Changes for source/overview/SimplifiedTangoDatamodel.rst: 34 added lines, 35 removed lines.
Original line number	Diff line number	Diff line
		.. highlight:: TangoDataModel

		Simplified Tango Data Model
		===========================
		Simplified Tango Device Server Model
		====================================

		This document is directed to beginner developer.

		Primary Presentation
		********************
		--------------------

		\|image0\|
		--------


		Elements
		********
		--------

		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Block \| Description \|
		+==================+=============================================================================================================================+
		+==================+==================================================================================================================================================================================================================================================================================================================================================+
		\| Device \| Abstract concept defined by the TANGO device server object model; it \|
		\| \| \|
		\| \| can be a piece of hardware (an interlock bit) a collection of hardware (a screen attached to a stepper motor) \|
		\| \| \|
		\| \| a logical device (a taper) or a combination of all these (an accelerator). \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| TANGO Class \| From Object Oriented Programming concept, this is the main class that the developer has to implement \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| DeviceServer \| Process that export devices available to accept requests (refer to section 3.4 of Tango User Manual) \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| DeviceServer \| The server (also referred as device server) is a process whose main task is to offer one or more services to one or more clients. To do this, the server has to spend most of its time in a wait loop waiting for clients to connect to it. The devices are hosted in the server process. A server is able to host several classes of devices. \|
		\| \| \|
		\| \| In short, it is a process that export devices available to accept requests). Please refer also to the :ref:`Glossary <glossary>`, :term:`Device Server instance`. \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| DeviceProperty \| Device specific configuration \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| Attribute \| See 3.3.2 section from the Tango Manual \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| Pipe \| See 3.3.3 section from the Tango Manual \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| Event \| Refer to 4.6 of Tango Manual. \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| Command \| See 3.3.1 section from the Tango Manual; A list of default command are available for the admin device at section 6.1.7.2. \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		\| State \| The device state is a number which reflects the availability of the device. Refer to 6.4.3 \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Attribute \| See :ref:`Glossary <glossary>`, :term:`Attribute`. \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Pipe \| See :ref:`Glossary <glossary>`, :term:`Pipe`. \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Event \| Refer to :ref:`Events <events_tangoclient>`. \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Command \| See :ref:`Glossary <commands_deviceservermodel>`. \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| State \| The device state is a number which reflects the availability of the device. \|
		\| \| \|
		\| \| Refer to :ref:`Events <choosingdevicestate_deviceserverwriting>` \|
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
		\| Status \| The state of the device as a formatted ascii string \|
		+------------------+-----------------------------------------------------------------------------------------------------------------------------+
		+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

		Attributes
		**********
		----------

		+-------------+-----------------+--------------------------+
		+-------------+----------------------+-------------------------------+
		\| Block \| Attribute \| Description \|
		+=============+=================+==========================+
		\| Device \| domain \| To identify the device \|
		+-------------+-----------------+--------------------------+
		\| \| family \| \|
		+-------------+-----------------+--------------------------+
		\| \| member \| \|
		+-------------+-----------------+--------------------------+
		+=============+======================+===============================+
		\| Device \| domain/family/member \| To identify the device \|
		+-------------+----------------------+-------------------------------+

		Relations
		*********
		---------

		+------------------+-------------------+--------------------+--------------------------------------------------------------+
		\| Left Block \| Right Block \| Multiplicity \| Description \|
		@@ -77,5 +77,4 @@ Relations
		+------------------+-------------------+--------------------+--------------------------------------------------------------+

		.. \|image0\| image:: SimplifiedTangoDatamodel/image2.jpg
		:width: 6.26772in
		:height: 3.27778in

source/tools/archiving/HDB++.rst

0 → 100644

+100

File added.

Preview size limit exceeded, changes collapsed.

source/tools/archiving/HDB/image2.png

0 → 100644

+40.5 KiB

Loading image diff...

source/tools/archiving/HDB/image4.png

0 → 100644

+44.2 KiB

Loading image diff...

source/tools/index.rst

Changes for source/tools/index.rst: 6 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -18,6 +18,12 @@ These tools are delivered as a part of Tango Controls core package.
		Archiving
		=========

		.. toctree::
		:maxdepth: 2
		:name: archivingtoc

		archiving/HDB++


		GUI building
		============