VirtualBox

source: vbox/trunk/src/VBox/Main/include/StorageControllerImpl.h@ 67954

Last change on this file since 67954 was 65088, checked in by vboxsync, 8 years ago

Main: doxygen fixes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.0 KB
Line 
1/* $Id: StorageControllerImpl.h 65088 2017-01-03 20:52:49Z vboxsync $ */
2
3/** @file
4 *
5 * VBox StorageController COM Class declaration.
6 */
7
8/*
9 * Copyright (C) 2008-2016 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#ifndef ____H_STORAGECONTROLLERIMPL
21#define ____H_STORAGECONTROLLERIMPL
22#include "StorageControllerWrap.h"
23
24class ATL_NO_VTABLE StorageController :
25 public StorageControllerWrap
26{
27public:
28
29 DECLARE_EMPTY_CTOR_DTOR(StorageController)
30
31 HRESULT FinalConstruct();
32 void FinalRelease();
33
34 // public initializer/uninitializer for internal purposes only
35 HRESULT init(Machine *aParent,
36 const com::Utf8Str &aName,
37 StorageBus_T aBus,
38 ULONG aInstance,
39 bool fBootable);
40 HRESULT init(Machine *aParent,
41 StorageController *aThat,
42 bool aReshare = false);
43 HRESULT initCopy(Machine *aParent,
44 StorageController *aThat);
45 void uninit();
46
47 // public methods only for internal purposes
48 const Utf8Str &i_getName() const;
49 StorageControllerType_T i_getControllerType() const;
50 StorageBus_T i_getStorageBus() const;
51 ULONG i_getInstance() const;
52 bool i_getBootable() const;
53 HRESULT i_checkPortAndDeviceValid(LONG aControllerPort,
54 LONG aDevice);
55 void i_setBootable(BOOL fBootable);
56 void i_rollback();
57 void i_commit();
58
59 // public methods for internal purposes only
60 // (ensure there is a caller and a read lock before calling them!)
61
62 void i_unshare();
63
64 /** @note this doesn't require a read lock since mParent is constant. */
65 Machine* i_getMachine();
66 ComObjPtr<StorageController> i_getPeer();
67
68private:
69
70 // Wrapped IStorageController properties
71 HRESULT getName(com::Utf8Str &aName);
72 HRESULT setName(const com::Utf8Str &aName);
73 HRESULT getMaxDevicesPerPortCount(ULONG *aMaxDevicesPerPortCount);
74 HRESULT getMinPortCount(ULONG *aMinPortCount);
75 HRESULT getMaxPortCount(ULONG *aMaxPortCount);
76 HRESULT getInstance(ULONG *aInstance);
77 HRESULT setInstance(ULONG aInstance);
78 HRESULT getPortCount(ULONG *aPortCount);
79 HRESULT setPortCount(ULONG aPortCount);
80 HRESULT getBus(StorageBus_T *aBus);
81 HRESULT getControllerType(StorageControllerType_T *aControllerType);
82 HRESULT setControllerType(StorageControllerType_T aControllerType);
83 HRESULT getUseHostIOCache(BOOL *aUseHostIOCache);
84 HRESULT setUseHostIOCache(BOOL aUseHostIOCache);
85 HRESULT getBootable(BOOL *aBootable);
86
87 void i_printList();
88
89 struct Data;
90 Data *m;
91};
92
93#endif //!____H_STORAGECONTROLLERIMPL
94/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette