File: miscellaneous.md

package info (click to toggle)
pytango 10.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 10,216 kB
  • sloc: python: 28,206; cpp: 16,380; sql: 255; sh: 82; makefile: 43
file content (182 lines) | stat: -rw-r--r-- 2,669 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
```{eval-rst}
.. currentmodule:: tango
```

# API util

```{eval-rst}
.. autoclass:: ApiUtil
    :members:
```

# Information classes

See also [Event configuration information]

## Attribute

```{eval-rst}
.. autoclass:: AttributeAlarmInfo
    :members:
```

```{eval-rst}
.. autoclass:: AttributeDimension
    :members:
```

```{eval-rst}
.. autoclass:: AttributeInfo
    :members:
```

```{eval-rst}
.. autoclass:: AttributeInfoEx
    :members:
```

see also {class}`AttributeInfo`

```{eval-rst}
.. autoclass:: DeviceAttributeConfig
    :members:
```

## Command

```{eval-rst}
.. autoclass:: DevCommandInfo
   :members:
```

```{eval-rst}
.. autoclass:: CommandInfo
   :members:
```

## Other

```{eval-rst}
.. autoclass:: DeviceInfo
    :members:
```

```{eval-rst}
.. autoclass:: LockerInfo
    :members:
```

```{eval-rst}
.. autoclass:: PollDevice
    :members:

```

# Storage classes

## Attribute: DeviceAttribute

```{eval-rst}
.. autoclass:: DeviceAttribute
    :members:

```

## Command: DeviceData

Device data is the type used internally by Tango to deal with command parameters
and return values. You don't usually need to deal with it, as command_inout
will automatically convert the parameters from any other type and the result
value to another type.

You can still use them, using command_inout_raw to get the result in a DeviceData.

You also may deal with it when reading command history.

```{eval-rst}
.. autoclass:: DeviceData
    :members:

```

# Callback related classes

If you subscribe a callback in a DeviceProxy, it will be run with a parameter.
This parameter depends will be of one of the following classes depending on
the callback type.

```{eval-rst}
.. autoclass:: AttrReadEvent
    :members:
```

```{eval-rst}
.. autoclass:: AttrWrittenEvent
    :members:
```

```{eval-rst}
.. autoclass:: CmdDoneEvent
    :members:

```

# Event related classes

## Event configuration information

```{eval-rst}
.. autoclass:: AttributeEventInfo
    :members:
```

```{eval-rst}
.. autoclass:: ArchiveEventInfo
    :members:
```

```{eval-rst}
.. autoclass:: ChangeEventInfo
    :members:
```

```{eval-rst}
.. autoclass:: PeriodicEventInfo
    :members:
```

## Event arrived structures

```{eval-rst}
.. autoclass:: EventData
    :members:
```

```{eval-rst}
.. autoclass:: AttrConfEventData
    :members:
```

```{eval-rst}
.. autoclass:: DataReadyEventData
    :members:

```

# History classes

```{eval-rst}
.. autoclass:: DeviceAttributeHistory
    :show-inheritance:
    :members:
```

See {class}`DeviceAttribute`.

```{eval-rst}
.. autoclass:: DeviceDataHistory
    :show-inheritance:
    :members:
```

See {class}`DeviceData`.