/[svn]/linuxsampler/trunk/src/engines/EngineChannelFactory.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/engines/EngineChannelFactory.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 899 - (show annotations) (download) (as text)
Wed Jul 5 17:43:48 2006 UTC (14 years, 2 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 2606 byte(s)
just added API doc

1 /***************************************************************************
2 * *
3 * Copyright (C) 2005, 2006 Christian Schoenebeck *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the Free Software *
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18 * MA 02111-1307 USA *
19 ***************************************************************************/
20
21 #ifndef __LS_ENGINECHANNELFACTORY_H__
22 #define __LS_ENGINECHANNELFACTORY_H__
23
24 #include <set>
25
26 #include "EngineChannel.h"
27
28 namespace LinuxSampler {
29
30 /** @brief Manages EngineChannel instances.
31 *
32 * This class is used to create and destroy EngineChannel instances of the
33 * various engine types supported by this sampler. It's basically used to
34 * avoid dependencies to palpable sampler engine types /
35 * implementations.
36 */
37 class EngineChannelFactory {
38 public:
39 /**
40 * Create EngineChannel instance of given engine type.
41 *
42 * @see EngineFactory::AvailableEngineTypes()
43 */
44 static EngineChannel* Create(String EngineType) throw (Exception);
45
46 /**
47 * Destroy given EngineChannel instance.
48 */
49 static void Destroy(EngineChannel* pEngineChannel);
50
51 /**
52 * Returns all EngineChannel instances.
53 */
54 static const std::set<EngineChannel*>& EngineChannelInstances();
55 };
56
57 } // namespace LinuxSampler
58
59 #endif // __LS_ENGINECHANNELFACTORY_H__

  ViewVC Help
Powered by ViewVC