← Back to branch summary

~ubuntu-branches/ubuntu/trusty/digikam/trusty

« back to all changes in this revision

Viewing changes to extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/hstoragesystem.h

  • Committer: Package Import Robot
  • Author(s): Rohan Garg
  • Date: 2012-11-26 18:24:20 UTC
  • mfrom: (1.9.1) (3.1.23 experimental)
  • Revision ID: package-import@ubuntu.com-20121126182420-qoy6z0nx4ai0wzcl
Tags: 4:3.0.0~beta3-0ubuntu1
https://launchpad.net/bugs/890059
https://launchpad.net/bugs/1011211
https://launchpad.net/bugs/658047
* New upstream release
  - Add build-deps :  libhupnp-dev, libqtgstreamer-dev, libmagickcore-dev
* Merge from debian, remaining changes:
  - Make sure libqt4-opengl-dev, libgl1-mesa-dev and libglu1-mesa-dev only
    install on i386,amd64 and powerpc
  - Depend on libtiff-dev instead of libtiff4-dev
  - Drop digikam breaks/replaces kipi-plugins-common since we're past the
    LTS release now
  - digikam to recommend mplayerthumbs | ffmpegthumbs. We currently only
    have latter in the archives, even though former is also supposed to
    be part of kdemultimedia. (LP: #890059)
  - kipi-plugins to recommend www-browser rather than konqueror directly
    since 2.8 no direct usage of konqueror is present in the flickr
    plugin anymore (LP: #1011211)
  - Keep kubuntu_mysqld_executable_name.diff
  - Don't install libkipi translations
  - Keep deps on libcv-dev, libcvaux-dev
  - Keep split packaging of libraries
  - Replace icons from KDE 3 time in debian/xpm.d/*.xpm with the new
    versions (LP: #658047)
* Update debian/not-installed

Show diffs side-by-side

added added

removed removed

Lines of Context:
extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/hstoragesystem.h
 
1
/*
 
2
 *  Copyright (C) 2011 Tuomo Penttinen, all rights reserved.
 
3
 *
 
4
 *  Author: Tuomo Penttinen <tp@herqq.org>
 
5
 *
 
6
 *  This file is part of Herqq UPnP Av (HUPnPAv) library.
 
7
 *
 
8
 *  Herqq UPnP Av is free software: you can redistribute it and/or modify
 
9
 *  it under the terms of the GNU General Public License as published by
 
10
 *  the Free Software Foundation, either version 3 of the License, or
 
11
 *  (at your option) any later version.
 
12
 *
 
13
 *  Herqq UPnP Av is distributed in the hope that it will be useful,
 
14
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
16
 *  GNU General Public License for more details.
 
17
 *
 
18
 *  You should have received a copy of the GNU General Public License
 
19
 *  along with Herqq UPnP Av. If not, see <http://www.gnu.org/licenses/>.
 
20
 */
 
21
 
 
22
#ifndef HSTORAGESYSTEM_H_
 
23
#define HSTORAGESYSTEM_H_
 
24
 
 
25
#include <HUpnpAv/HContainer>
 
26
 
 
27
namespace Herqq
 
28
{
 
29
 
 
30
namespace Upnp
 
31
{
 
32
 
 
33
namespace Av
 
34
{
 
35
 
 
36
class HStorageSystemPrivate;
 
37
 
 
38
/*!
 
39
 * \brief This class represents potentially heterogeneous collection of storage media.
 
40
 *
 
41
 * The class identifier specified by the AV Working Committee is
 
42
 * \c object.container.storageSystem.
 
43
 *
 
44
 * \headerfile hstoragesystem.h HStorageSystem
 
45
 *
 
46
 * \ingroup hupnp_av_cds_objects
 
47
 *
 
48
 * \remarks This class is not thread-safe.
 
49
 */
 
50
class H_UPNP_AV_EXPORT HStorageSystem :
 
51
    public HContainer
 
52
{
 
53
Q_OBJECT
 
54
H_DISABLE_COPY(HStorageSystem)
 
55
H_DECLARE_PRIVATE(HStorageSystem)
 
56
 
 
57
protected:
 
58
 
 
59
    /*!
 
60
     * Constructs a new instance.
 
61
     *
 
62
     * \param clazz specifies the UPnP class of the object. This cannot be empty.
 
63
     *
 
64
     * \param cdsType specifies the CDS type of the object. This cannot be
 
65
     * HObject::UndefinedCdsType.
 
66
     *
 
67
     * \sa isInitialized()
 
68
     */
 
69
    HStorageSystem(const QString& clazz = sClass(), CdsType cdsType = sType());
 
70
    HStorageSystem(HStorageSystemPrivate&);
 
71
 
 
72
    // Documented in HClonable
 
73
    virtual HStorageSystem* newInstance() const;
 
74
 
 
75
public:
 
76
 
 
77
    /*!
 
78
     * \brief Creates a new instance.
 
79
     *
 
80
     * \param title specifies the title of the object.
 
81
     *
 
82
     * \param parentId specifies the ID of the object that contains this
 
83
     * object. If the object has no parent, this has to be left empty.
 
84
     *
 
85
     * \param id specifies the ID of this object. If this is not specified,
 
86
     * a unique identifier within the running process is created for the object.
 
87
     *
 
88
     * \sa isValid()
 
89
     */
 
90
    HStorageSystem(
 
91
        const QString& title,
 
92
        const QString& parentId,
 
93
        const QString& id = QString());
 
94
 
 
95
    /*!
 
96
     * \brief Destroys the instance.
 
97
     */
 
98
    virtual ~HStorageSystem();
 
99
 
 
100
    /*!
 
101
     * \brief Returns the total capacity in bytes of the storage represented by the
 
102
     * container.
 
103
     *
 
104
     * upnp:storageTotal, ContentDirectory:3, Appendix B.6.1.
 
105
     *
 
106
     * \return he total capacity in bytes of the storage represented by the
 
107
     * container.
 
108
     *
 
109
     * \sa setStorageTotal()
 
110
     */
 
111
    qint64 storageTotal() const;
 
112
 
 
113
    /*!
 
114
     * \brief Returns the combined space in bytes used by all the objects held
 
115
     * in storage represented by this container.
 
116
     *
 
117
     * upnp:storageUsed, ContentDirectory:3, Appendix B.6.2.
 
118
     *
 
119
     * \return The combined space in bytes used by all the objects held
 
120
     * in storage represented by this container.
 
121
     *
 
122
     * \sa setStorageUsed()
 
123
     */
 
124
    qint64 storageUsed() const;
 
125
 
 
126
    /*!
 
127
     * \brief Returns the total free capacity in bytes of the storage represented by
 
128
     * the container.
 
129
     *
 
130
     * upnp:storageFree, ContentDirectory:3, Appendix B.6.3
 
131
     *
 
132
     * \return The total free capacity in bytes of the storage represented by
 
133
     * the container.
 
134
     *
 
135
     * \sa setStorageFree()
 
136
     */
 
137
    qint64 storageFree() const;
 
138
 
 
139
    /*!
 
140
     * \brief Returns the largest amount of space in bytes available for storing
 
141
     * a single resource in the container.
 
142
     *
 
143
     * upnp:storageMaxPartition, ContentDirectory:3, Appendix B.6.4.
 
144
     *
 
145
     * \return The largest amount of space in bytes available for storing
 
146
     * a single resource in the container.
 
147
     *
 
148
     * \sa setStorageMaxPartition()
 
149
     */
 
150
    qint64 storageMaxPartition() const;
 
151
 
 
152
    /*!
 
153
     * \brief Indicates the type of storage medium used for the content.
 
154
     *
 
155
     * upnp:storageMedium, ContentDirectory:3, Appendix B.6.5.
 
156
     *
 
157
     * \return The type of storage medium used for the content.
 
158
     *
 
159
     * \sa setStorageMedium()
 
160
     */
 
161
    HStorageMedium storageMedium() const;
 
162
 
 
163
    /*!
 
164
     * \brief Specifies the total capacity in bytes of the storage represented by the
 
165
     * container.
 
166
     *
 
167
     * \param arg specifies the total capacity in bytes of the storage represented by the
 
168
     * container.
 
169
     *
 
170
     * \sa storageTotal()
 
171
     */
 
172
    void setStorageTotal(qint64 arg);
 
173
 
 
174
    /*!
 
175
     * \brief Specifies the combined space in bytes used by all the objects held
 
176
     * in storage represented by this container.
 
177
     *
 
178
     * \param arg specifies the combined space in bytes used by all the objects held
 
179
     * in storage represented by this container.
 
180
     *
 
181
     * \sa storageUsed()
 
182
     */
 
183
    void setStorageUsed(qint64 arg);
 
184
 
 
185
    /*!
 
186
     * \brief Specifies the total free capacity in bytes of the storage represented by
 
187
     * the container.
 
188
     *
 
189
     * \param arg specifies the total free capacity in bytes of the storage represented by
 
190
     * the container.
 
191
     *
 
192
     * \sa storageFree()
 
193
     */
 
194
    void setStorageFree(qint64 arg);
 
195
 
 
196
    /*!
 
197
     * \brief Specifies the largest amount of space in bytes available for storing
 
198
     * a single resource in the container.
 
199
     *
 
200
     * \param arg specifies the largest amount of space in bytes available for storing
 
201
     * a single resource in the container.
 
202
     *
 
203
     * \sa storageMaxPartition()
 
204
     */
 
205
    void setStorageMaxPartition(qint64 arg);
 
206
 
 
207
    /*!
 
208
     * \brief Specifies the type of storage medium used for the content.
 
209
     *
 
210
     * \param arg specifies the type of storage medium used for the content.
 
211
     *
 
212
     * \sa storageMedium()
 
213
     */
 
214
    void setStorageMedium(const HStorageMedium& arg);
 
215
 
 
216
    /*!
 
217
     * \brief Returns the CdsType value of this class.
 
218
     *
 
219
     * \return The CdsType value of this class.
 
220
     */
 
221
    inline static CdsType sType() { return StorageSystem; }
 
222
 
 
223
    /*!
 
224
     * \brief Returns the class identifier specified by the AV Working Committee.
 
225
     *
 
226
     * \return The class identifier specified by the AV Working Committee.
 
227
     */
 
228
    inline static QString sClass() { return "object.container.storageSystem"; }
 
229
 
 
230
    /*!
 
231
     * Creates a new instance with no title or parentID.
 
232
     *
 
233
     * \return a pointer to the newly created instance.
 
234
     *
 
235
     * \remarks the ownership of the object is transferred to the caller. Make sure
 
236
     * to delete the object.
 
237
     */
 
238
    inline static HStorageSystem* create() { return new HStorageSystem(); }
 
239
};
 
240
 
 
241
}
 
242
}
 
243
}
 
244
 
 
245
#endif /* HSTORAGESYSTEM_H_ */