Ocean
PatternDevice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_DEVICES_PATTERN_DEVICE_H
9 #define META_OCEAN_DEVICES_PATTERN_DEVICE_H
10 
12 
13 #include "ocean/devices/Device.h"
14 
15 namespace Ocean
16 {
17 
18 namespace Devices
19 {
20 
21 namespace Pattern
22 {
23 
24 /**
25  * This class implements a base class for all devices of the Pattern library.
26  * @ingroup devicespattern
27  */
28 class OCEAN_DEVICES_PATTERN_EXPORT PatternDevice : virtual public Device
29 {
30  public:
31 
32  /**
33  * Returns the name of the owner library.
34  * @see Device::library().
35  */
36  virtual const std::string& library() const;
37 
38  protected:
39 
40  /**
41  * Creates a new device by is name.
42  * @param name The name of the device
43  * @param type Major and minor device type of the device
44  */
45  PatternDevice(const std::string& name, const DeviceType type);
46 };
47 
48 }
49 
50 }
51 
52 }
53 
54 #endif // META_OCEAN_DEVICES_PATTERN_DEVICE_H
Definition of a class holding the major and minor device type.
Definition: devices/Device.h:62
This class is the base class for all devices of any type.
Definition: devices/Device.h:28
This class implements a base class for all devices of the Pattern library.
Definition: PatternDevice.h:29
virtual const std::string & library() const
Returns the name of the owner library.
PatternDevice(const std::string &name, const DeviceType type)
Creates a new device by is name.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15