VirtualBox

source: vbox/trunk/src/VBox/Main/include/SnapshotImpl.h@ 7692

Last change on this file since 7692 was 6076, checked in by vboxsync, 17 years ago

Merged dmik/s2 branch (r25959:26751) to the trunk.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1/** @file
2 *
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef ____H_SNAPSHOTIMPL
19#define ____H_SNAPSHOTIMPL
20
21#include "VirtualBoxBase.h"
22#include "Collection.h"
23
24#include <iprt/time.h>
25
26#include <list>
27
28class SnapshotMachine;
29
30class ATL_NO_VTABLE Snapshot :
31 public VirtualBoxSupportErrorInfoImpl <Snapshot, ISnapshot>,
32 public VirtualBoxSupportTranslation <Snapshot>,
33 public VirtualBoxBaseWithTypedChildren <Snapshot>,
34 public ISnapshot
35{
36public:
37
38 struct Data
39 {
40 Data();
41 ~Data();
42
43 Guid mId;
44 Bstr mName;
45 Bstr mDescription;
46 RTTIMESPEC mTimeStamp;
47 ComObjPtr <SnapshotMachine> mMachine;
48 };
49
50 typedef VirtualBoxBaseWithTypedChildren <Snapshot>::DependentChildren
51 SnapshotList;
52
53 DECLARE_NOT_AGGREGATABLE(Snapshot)
54
55 DECLARE_PROTECT_FINAL_CONSTRUCT()
56
57 BEGIN_COM_MAP(Snapshot)
58 COM_INTERFACE_ENTRY(ISupportErrorInfo)
59 COM_INTERFACE_ENTRY(ISnapshot)
60 END_COM_MAP()
61
62 NS_DECL_ISUPPORTS
63
64 HRESULT FinalConstruct();
65 void FinalRelease();
66
67 // public initializer/uninitializer only for internal purposes
68 HRESULT init (const Guid &aId, INPTR BSTR aName, INPTR BSTR aDescription,
69 RTTIMESPEC aTimeStamp, SnapshotMachine *aMachine,
70 Snapshot *aParent);
71 void uninit();
72
73 void discard();
74
75 // ISnapshot properties
76 STDMETHOD(COMGETTER(Id)) (GUIDPARAMOUT aId);
77 STDMETHOD(COMGETTER(Name)) (BSTR *aName);
78 STDMETHOD(COMSETTER(Name)) (INPTR BSTR aName);
79 STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
80 STDMETHOD(COMSETTER(Description)) (INPTR BSTR aDescription);
81 STDMETHOD(COMGETTER(TimeStamp)) (LONG64 *aTimeStamp);
82 STDMETHOD(COMGETTER(Online)) (BOOL *aOnline);
83 STDMETHOD(COMGETTER(Machine)) (IMachine **aMachine);
84 STDMETHOD(COMGETTER(Parent)) (ISnapshot **aParent);
85 STDMETHOD(COMGETTER(Children)) (ISnapshotCollection **aChildren);
86
87 // ISnapshot methods
88
89 // public methods only for internal purposes
90
91 /** Do |AutoLock alock (this);| before acceessing the returned data! */
92 const Data &data() const { return mData; }
93
94 const Bstr &stateFilePath() const;
95
96 ComObjPtr <Snapshot> parent() const { return (Snapshot *) mParent; }
97
98 /** Shortcut to #dependentChildrenLock() */
99 AutoLock::Handle &childrenLock() const { return dependentChildrenLock(); }
100
101 /**
102 * Shortcut to #dependentChildren().
103 * Do |AutoLock alock (childrenLock());| before acceessing the returned list!
104 */
105 const SnapshotList &children() const { return dependentChildren(); }
106
107 ULONG descendantCount();
108 ComObjPtr <Snapshot> findChildOrSelf (INPTR GUIDPARAM aId);
109 ComObjPtr <Snapshot> findChildOrSelf (INPTR BSTR aName);
110
111 bool isDVDImageUsed (const Guid &aId);
112 bool isFloppyImageUsed (const Guid &aId);
113
114 void updateSavedStatePaths (const char *aOldPath, const char *aNewPath);
115
116 // for VirtualBoxSupportErrorInfoImpl
117 static const wchar_t *getComponentName() { return L"Snapshot"; }
118
119private:
120
121 ComObjPtr <Snapshot, ComWeakRef> mParent;
122
123 Data mData;
124};
125
126COM_DECL_READONLY_ENUM_AND_COLLECTION (Snapshot)
127
128#endif // ____H_SNAPSHOTIMPL
129
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