Main/include/USBDeviceImpl.h

	USBDeviceImpl.h revision fc148a6b23d25a87561beaffe0ba06c3ba93bf5a
072f0b86f23a38efb7454da3144cbce76805be76vboxsync/* $Id$ */
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync/** @file
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Header file for the OUSBDevice (IUSBDevice) class, VBoxC.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync */
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync/*
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync *
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * available from http://www.virtualbox.org. This file is free software;
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * you can redistribute it and/or modify it under the terms of the GNU
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * General Public License (GPL) as published by the Free Software
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync *
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * additional information or have any questions.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync */
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync#ifndef ____H_USBDEVICEIMPL
072f0b86f23a38efb7454da3144cbce76805be76vboxsync#define ____H_USBDEVICEIMPL
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync#include "VirtualBoxBase.h"
072f0b86f23a38efb7454da3144cbce76805be76vboxsync#include "Logging.h"
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync/**
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Object class used for maintaining devices attached to a USB controller.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync * Generally this contains much less information.
072f0b86f23a38efb7454da3144cbce76805be76vboxsync */
072f0b86f23a38efb7454da3144cbce76805be76vboxsyncclass ATL_NO_VTABLE OUSBDevice :
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    public VirtualBoxBase,
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    public VirtualBoxSupportErrorInfoImpl<OUSBDevice, IUSBDevice>,
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    public VirtualBoxSupportTranslation<OUSBDevice>,
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    VBOX_SCRIPTABLE_IMPL(IUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync{
072f0b86f23a38efb7454da3144cbce76805be76vboxsyncpublic:
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (OUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    DECLARE_NOT_AGGREGATABLE(OUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    DECLARE_PROTECT_FINAL_CONSTRUCT()
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    BEGIN_COM_MAP(OUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync        COM_INTERFACE_ENTRY  (ISupportErrorInfo)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync        COM_INTERFACE_ENTRY  (IUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync        COM_INTERFACE_ENTRY2 (IDispatch, IUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    END_COM_MAP()
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    DECLARE_EMPTY_CTOR_DTOR (OUSBDevice)
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    HRESULT FinalConstruct();
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    void FinalRelease();
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    // public initializer/uninitializer for internal purposes only
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    HRESULT init (IUSBDevice *a_pUSBDevice);
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    void uninit();
072f0b86f23a38efb7454da3144cbce76805be76vboxsync
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    // IUSBDevice properties
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    STDMETHOD(COMGETTER(Id))(BSTR *aId);
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    STDMETHOD(COMGETTER(VendorId))(USHORT *aVendorId);
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    STDMETHOD(COMGETTER(ProductId))(USHORT *aProductId);
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    STDMETHOD(COMGETTER(Revision))(USHORT *aRevision);
072f0b86f23a38efb7454da3144cbce76805be76vboxsync    STDMETHOD(COMGETTER(Manufacturer))(BSTR *aManufacturer);
    STDMETHOD(COMGETTER(Product))(BSTR *aProduct);
    STDMETHOD(COMGETTER(SerialNumber))(BSTR *aSerialNumber);
    STDMETHOD(COMGETTER(Address))(BSTR *aAddress);
    STDMETHOD(COMGETTER(Port))(USHORT *aPort);
    STDMETHOD(COMGETTER(Version))(USHORT *aVersion);
    STDMETHOD(COMGETTER(PortVersion))(USHORT *aPortVersion);
    STDMETHOD(COMGETTER(Remote))(BOOL *aRemote);

    // public methods only for internal purposes
    const Guid &id() const { return mData.id; }

    // for VirtualBoxSupportErrorInfoImpl
    static const wchar_t *getComponentName() { return L"USBDevice"; }

private:

    struct Data
    {
        Data() : vendorId (0), productId (0), revision (0), port (0),
                 version (1), portVersion (1), remote (FALSE) {}

        /** The UUID of this device. */
        const Guid id;

        /** The vendor id of this USB device. */
        const USHORT vendorId;
        /** The product id of this USB device. */
        const USHORT productId;
        /** The product revision number of this USB device.
         * (high byte = integer; low byte = decimal) */
        const USHORT revision;
        /** The Manufacturer string. (Quite possibly NULL.) */
        const Bstr manufacturer;
        /** The Product string. (Quite possibly NULL.) */
        const Bstr product;
        /** The SerialNumber string. (Quite possibly NULL.) */
        const Bstr serialNumber;
        /** The host specific address of the device. */
        const Bstr address;
        /** The host port number. */
        const USHORT port;
        /** The major USB version number of the device. */
        const USHORT version;
        /** The major USB version number of the port the device is attached to. */
        const USHORT portVersion;
        /** Remote (VRDP) or local device. */
        const BOOL remote;
    };

    Data mData;
};

#endif // ____H_USBDEVICEIMPL
/* vi: set tabstop=4 shiftwidth=4 expandtab: */