VirtualBox

source: vbox/trunk/src/VBox/Main/include/MediumAttachmentImpl.h@ 69498

Last change on this file since 69498 was 69498, checked in by vboxsync, 7 years ago

backed out r118835 as it incorrectly updated the 'This file is based on' file headers.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 4.3 KB
Line 
1/* $Id: MediumAttachmentImpl.h 69498 2017-10-28 15:07:25Z vboxsync $ */
2/** @file
3 *
4 * VirtualBox COM class implementation
5 */
6
7/*
8 * Copyright (C) 2006-2016 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19#ifndef ____H_MEDIUMATTACHMENTIMPL
20#define ____H_MEDIUMATTACHMENTIMPL
21
22#include "MediumAttachmentWrap.h"
23
24class ATL_NO_VTABLE MediumAttachment :
25 public MediumAttachmentWrap
26{
27public:
28
29 DECLARE_EMPTY_CTOR_DTOR(MediumAttachment)
30
31 HRESULT FinalConstruct();
32 void FinalRelease();
33
34 // public initializer/uninitializer for internal purposes only
35 HRESULT init(Machine *aParent,
36 Medium *aMedium,
37 const Utf8Str &aControllerName,
38 LONG aPort,
39 LONG aDevice,
40 DeviceType_T aType,
41 bool aImplicit,
42 bool aPassthrough,
43 bool aTempEject,
44 bool aNonRotational,
45 bool aDiscard,
46 bool aHotPluggable,
47 const Utf8Str &strBandwidthGroup);
48 HRESULT initCopy(Machine *aParent, MediumAttachment *aThat);
49 void uninit();
50
51 // public internal methods
52 void i_rollback();
53 void i_commit();
54
55 // unsafe public methods for internal purposes only (ensure there is
56 // a caller and a read lock before calling them!)
57 bool i_isImplicit() const;
58 void i_setImplicit(bool aImplicit);
59
60 const ComObjPtr<Medium>& i_getMedium() const;
61 const Utf8Str &i_getControllerName() const;
62 LONG i_getPort() const;
63 LONG i_getDevice() const;
64 DeviceType_T i_getType() const;
65 bool i_getPassthrough() const;
66 bool i_getTempEject() const;
67 bool i_getNonRotational() const;
68 bool i_getDiscard() const;
69 Utf8Str& i_getBandwidthGroup() const;
70 bool i_getHotPluggable() const;
71
72 bool i_matches(const Utf8Str &aControllerName, LONG aPort, LONG aDevice);
73
74 /** Must be called from under this object's write lock. */
75 void i_updateName(const Utf8Str &aName);
76
77 /** Must be called from under this object's write lock. */
78 void i_updateMedium(const ComObjPtr<Medium> &aMedium);
79
80 /** Must be called from under this object's write lock. */
81 void i_updatePassthrough(bool aPassthrough);
82
83 /** Must be called from under this object's write lock. */
84 void i_updateTempEject(bool aTempEject);
85
86 /** Must be called from under this object's write lock. */
87 void i_updateNonRotational(bool aNonRotational);
88
89 /** Must be called from under this object's write lock. */
90 void i_updateDiscard(bool aDiscard);
91
92 /** Must be called from under this object's write lock. */
93 void i_updateEjected();
94
95 /** Must be called from under this object's write lock. */
96 void i_updateBandwidthGroup(const Utf8Str &aBandwidthGroup);
97
98 void i_updateParentMachine(Machine * const pMachine);
99
100 /** Must be called from under this object's write lock. */
101 void i_updateHotPluggable(bool aHotPluggable);
102
103 /** Construct a unique and somewhat descriptive name for logging. */
104 void i_updateLogName(void);
105
106 /** Get a unique and somewhat descriptive name for logging. */
107 const char *i_getLogName(void) const { return mLogName.c_str(); }
108
109private:
110
111 // Wrapped IMediumAttachment properties
112 HRESULT getMedium(ComPtr<IMedium> &aHardDisk);
113 HRESULT getController(com::Utf8Str &aController);
114 HRESULT getPort(LONG *aPort);
115 HRESULT getDevice(LONG *aDevice);
116 HRESULT getType(DeviceType_T *aType);
117 HRESULT getPassthrough(BOOL *aPassthrough);
118 HRESULT getTemporaryEject(BOOL *aTemporaryEject);
119 HRESULT getIsEjected(BOOL *aEjected);
120 HRESULT getDiscard(BOOL *aDiscard);
121 HRESULT getNonRotational(BOOL *aNonRotational);
122 HRESULT getBandwidthGroup(ComPtr<IBandwidthGroup> &aBandwidthGroup);
123 HRESULT getHotPluggable(BOOL *aHotPluggable);
124
125 struct Data;
126 Data *m;
127
128 Utf8Str mLogName; /**< For logging purposes */
129};
130
131#endif // !____H_MEDIUMATTACHMENTIMPL
132/* 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