SnapshotImpl.h revision f6365302c87bc7b6adfca280513ec92f06ed0132
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/** @file
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VirtualBox COM class implementation
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * available from http://www.virtualbox.org. This file is free software;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * General Public License (GPL) as published by the Free Software
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * additional information or have any questions.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef ____H_SNAPSHOTIMPL
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#define ____H_SNAPSHOTIMPL
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#include "VirtualBoxBase.h"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#include <iprt/time.h>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsyncclass SnapshotMachine;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsyncclass VirtualBox;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncnamespace settings
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync struct Snapshot;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncclass ATL_NO_VTABLE Snapshot :
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync public VirtualBoxSupportErrorInfoImpl<Snapshot, ISnapshot>,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync public VirtualBoxSupportTranslation<Snapshot>,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync public VirtualBoxBase, // WithTypedChildren<Snapshot>,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync VBOX_SCRIPTABLE_IMPL(ISnapshot)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncpublic:
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLARE_NOT_AGGREGATABLE(Snapshot)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync BEGIN_COM_MAP(Snapshot)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync COM_INTERFACE_ENTRY (ISupportErrorInfo)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync COM_INTERFACE_ENTRY (ISnapshot)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync COM_INTERFACE_ENTRY2 (IDispatch, ISnapshot)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync END_COM_MAP()
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync Snapshot()
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync : m(NULL)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync { };
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ~Snapshot()
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync { };
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync HRESULT FinalConstruct();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void FinalRelease();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync // public initializer/uninitializer only for internal purposes
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync HRESULT init(VirtualBox *aVirtualBox,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const Guid &aId,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const Utf8Str &aName,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const Utf8Str &aDescription,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const RTTIMESPEC &aTimeStamp,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync SnapshotMachine *aMachine,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync Snapshot *aParent);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void uninit();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void beginDiscard();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void deparent();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync // ISnapshot properties
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Id)) (BSTR *aId);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Name)) (BSTR *aName);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMSETTER(Name)) (IN_BSTR aName);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMSETTER(Description)) (IN_BSTR aDescription);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(TimeStamp)) (LONG64 *aTimeStamp);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Online)) (BOOL *aOnline);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Machine)) (IMachine **aMachine);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Parent)) (ISnapshot **aParent);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync STDMETHOD(COMGETTER(Children)) (ComSafeArrayOut (ISnapshot *, aChildren));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync // ISnapshot methods
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync // public methods only for internal purposes
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const ComObjPtr<Snapshot>& getParent() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const Utf8Str& stateFilePath() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ULONG getChildrenCount();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ULONG getAllChildrenCount();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ULONG getAllChildrenCountImpl();
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const ComObjPtr<SnapshotMachine>& getSnapshotMachine() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync Guid getId() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const Utf8Str& getName() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync RTTIMESPEC getTimeStamp() const;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ComObjPtr<Snapshot> findChildOrSelf(IN_GUID aId);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync ComObjPtr<Snapshot> findChildOrSelf(const Utf8Str &aName);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void updateSavedStatePaths(const char *aOldPath,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const char *aNewPath);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void updateSavedStatePathsImpl(const char *aOldPath,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync const char *aNewPath);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync HRESULT saveSnapshot(settings::Snapshot &data, bool aAttrsOnly);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync HRESULT saveSnapshotImpl(settings::Snapshot &data, bool aAttrsOnly);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync // for VirtualBoxSupportErrorInfoImpl
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync static const wchar_t *getComponentName()
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync {
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync return L"Snapshot";
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncprivate:
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync struct Data; // opaque, defined in SnapshotImpl.cpp
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync Data *m;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync};
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif // ____H_SNAPSHOTIMPL
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* vi: set tabstop=4 shiftwidth=4 expandtab: */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync