home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / tutsamp / aptserve / utilcar.h < prev   
C/C++ Source or Header  |  1997-08-05  |  7KB  |  179 lines
  1. /*+==========================================================================
  2.   File:      UTILCAR.H
  3.  
  4.   Summary:   Include file for the aggregatable COUtilityCar COM object class.
  5.  
  6.              UTILCAR showcases the construction of the COUtilityCar COM
  7.              object class with the IUnknown, ICar, and IUtility
  8.              interfaces. This is done through Containment reuse of COCar's
  9.              ICar interface features.
  10.  
  11.              This multiple interface COM Object Class is achieved via the
  12.              technique of nested classes: the implementation of the ICar
  13.              and IUtility interfaces are nested inside of the COUtilityCar
  14.              COM object class.
  15.  
  16.              For a comprehensive tutorial code tour of this module's
  17.              contents and offerings see the tutorial APTSERVE.HTM
  18.              file. For more specific technical details on the internal
  19.              workings see the comments dispersed throughout the module's
  20.              source code.
  21.  
  22.   Classes:   COUtilityCar
  23.  
  24.   Functions: .
  25.  
  26.   Origin:    3-20-96: atrent - Editor-inheritance from UTILCAR.H in
  27.                the LOCSERVE Tutorial Code Sample.
  28.  
  29. ----------------------------------------------------------------------------
  30.   This file is part of the Microsoft COM Tutorial Code Samples.
  31.  
  32.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  33.  
  34.   This source code is intended only as a supplement to Microsoft
  35.   Development Tools and/or on-line documentation.  See these other
  36.   materials for detailed information regarding Microsoft code samples.
  37.  
  38.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  39.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  40.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  41.   PARTICULAR PURPOSE.
  42. ==========================================================================+*/
  43.  
  44. #if !defined(UTILCAR_H)
  45. #define UTILCAR_H
  46.  
  47. #ifdef __cplusplus
  48.  
  49. /*O+O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O
  50.   ObjectClass: COUtilityCar
  51.  
  52.   Summary:     COM Object Class for COUtilityCar COM Objects.  COM objects
  53.                of this class augment COCar COM objects (which offer ICar
  54.                interface features of Shift, Clutch, Speed, and Steer) with
  55.                IUtility interface features (Offroad and Winch).  This
  56.                COUtilityCar COM object class is constructed by containment
  57.                reuse of the COCar COM object class.  The mulitple
  58.                interfaces on this COM object class are constructed via
  59.                the nested interface classes technique.
  60.  
  61.   Interfaces:  IUnknown
  62.                  Standard interface providing COM object features.
  63.                ICar
  64.                  Basic Car operation features.
  65.                IUtility
  66.                  Sport-utility vehicle offroad features.
  67.  
  68.   Aggregation: Yes, COUtilityCar COM objects are aggregatable by passing
  69.                a non-NULL pUnkOuter IUnknown pointer into the constructor.
  70. O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O-O*/
  71. class COUtilityCar : public IUnknown
  72. {
  73.   public:
  74.     // Main Object Constructor & Destructor.
  75.     COUtilityCar(IUnknown* pUnkOuter, CServer* pServer);
  76.     ~COUtilityCar(void);
  77.  
  78.     // A general method for initializing a newly created COUtilityCar.
  79.     HRESULT Init(void);
  80.  
  81.     // IUnknown methods. Main object, non-delegating.
  82.     STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  83.     STDMETHODIMP_(ULONG) AddRef(void);
  84.     STDMETHODIMP_(ULONG) Release(void);
  85.  
  86.     // We get this ICar interface pointer via containment reuse of the
  87.     // ICar interface in an instantiated COCar.
  88.     ICar*           m_pICar;
  89.  
  90.   private:
  91.     // We show nested interface class implementations here.
  92.  
  93.     // We implement the basic ICar interface in this COUtilityCar
  94.     // COM object class.
  95.     class CImpICar : public ICar
  96.     {
  97.       public:
  98.         // Interface Implementation Constructor & Destructor.
  99.         CImpICar(COUtilityCar* pBackObj, IUnknown* pUnkOuter);
  100.         ~CImpICar(void);
  101.  
  102.         // IUnknown methods.
  103.         STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  104.         STDMETHODIMP_(ULONG) AddRef(void);
  105.         STDMETHODIMP_(ULONG) Release(void);
  106.  
  107.         // ICar methods.
  108.         STDMETHODIMP Shift(short nGear);
  109.         STDMETHODIMP Clutch(short nEngaged);
  110.         STDMETHODIMP Speed(short nMph);
  111.         STDMETHODIMP Steer(short nAngle);
  112.  
  113.       private:
  114.         // Data private to this COUtilityCar interface implementation of ICar.
  115.         ULONG         m_cRefI;       // Interface Ref Count (for debugging).
  116.         COUtilityCar* m_pBackObj;    // Parent Object back pointer.
  117.         IUnknown*     m_pUnkOuter;   // Outer unknown for Delegation.
  118.     };
  119.  
  120.     // We implement the IUtility interface (ofcourse) in this COUtilityCar
  121.     // COM object class.  This is the native interface that we are using
  122.     // as an augmentation to the existing COCar COM object class.
  123.     class CImpIUtility : public IUtility
  124.     {
  125.       public:
  126.         // Interface Implementation Constructor & Destructor.
  127.         CImpIUtility(COUtilityCar* pBackObj, IUnknown* pUnkOuter);
  128.         ~CImpIUtility(void);
  129.  
  130.         // IUnknown methods.
  131.         STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  132.         STDMETHODIMP_(ULONG) AddRef(void);
  133.         STDMETHODIMP_(ULONG) Release(void);
  134.  
  135.         // IUtility methods.
  136.         STDMETHODIMP Offroad(short nGear);
  137.         STDMETHODIMP Winch(short nRpm);
  138.  
  139.       private:
  140.         // Data private to this interface implementation of IUtility.
  141.         ULONG         m_cRefI;       // Interface Ref Count (for debugging).
  142.         COUtilityCar* m_pBackObj;    // Parent Object back pointer.
  143.         IUnknown*     m_pUnkOuter;   // Outer unknown for Delegation.
  144.     };
  145.  
  146.     // Make the otherwise private and nested ICar and IUtility interface
  147.     // implementations a friend to COM object instantiations of this
  148.     // selfsame COUtilityCar COM object class.
  149.     friend CImpICar;
  150.     friend CImpIUtility;
  151.  
  152.     // Private data of COUtilityCar COM objects.
  153.  
  154.     // Nested ICar implementation instantiation.
  155.     CImpICar        m_ImpICar;
  156.  
  157.     // Nested IUtility implementation instantiation.  This IUtility interface
  158.     // is implemented inside this COUtilityCar object as a native interface.
  159.     CImpIUtility    m_ImpIUtility;
  160.  
  161.     // Main Object reference count.
  162.     ULONG           m_cRefs;
  163.  
  164.     // Outer unknown (aggregation & delegation). Used when this COCruiseCar
  165.     // object is being aggregated.  Otherwise it is used for delegation
  166.     // if this object is reused via containment.
  167.     IUnknown*       m_pUnkOuter;
  168.  
  169.     // Pointer to this component server's control object.
  170.     CServer*        m_pServer;
  171. };
  172.  
  173. typedef COUtilityCar* PCOUtilityCar;
  174.  
  175. #endif // __cplusplus
  176.  
  177.  
  178. #endif // UTILCAR_H
  179.