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 / comuser / utcrucar.h < prev   
C/C++ Source or Header  |  1997-08-05  |  7KB  |  164 lines
  1. /*+==========================================================================
  2.   File:      UTCRUCAR.H
  3.  
  4.   Summary:   Include file for the aggregatable COUtilityCruiseCar COM
  5.              object class.
  6.  
  7.              UTCRUCAR showcases the construction of the COUtilityCruiseCar
  8.              COM object class with the IUnknown, ICar, ICruise, and IUtility
  9.              interfaces.  This is done through Aggregation reuse of a
  10.              COCruiseCar COM object (specifically providing its ICar and
  11.              ICruise interface features).  COUtilityCruiseCar adds its own
  12.              native implementation of the IUtility interface.  The
  13.              aggregated CruiseCar object is implemented and provided in
  14.              an outside COMOBJ.DLL.
  15.  
  16.              This multiple interface COM Object Class is achieved via
  17.              the technique of nested classes: the implementation of the
  18.              IUtility interface is nested inside of the COUtilityCruiseCar
  19.              COM object class.
  20.  
  21.              For a comprehensive tutorial code tour of this module's
  22.              contents and offerings see the tutorial COMUSER.HTM
  23.              file.  For more specific technical details on the internal
  24.              workings see the comments dispersed throughout the
  25.              module's source code.
  26.  
  27.   Classes:   COUtilityCruiseCar
  28.  
  29.   Functions: .
  30.  
  31.   Origin:    8-29-95: atrent - Editor inheritance from CRUCAR.H.
  32.  
  33. ----------------------------------------------------------------------------
  34.   This file is part of the Microsoft COM Tutorial Code Samples.
  35.  
  36.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  37.  
  38.   This source code is intended only as a supplement to Microsoft
  39.   Development Tools and/or on-line documentation.  See these other
  40.   materials for detailed information regarding Microsoft code samples.
  41.  
  42.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  43.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  44.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  45.   PARTICULAR PURPOSE.
  46. ==========================================================================+*/
  47.  
  48. #if !defined(UTCRUCAR_H)
  49. #define UTCRUCAR_H
  50.  
  51. #ifdef __cplusplus
  52.  
  53. /*O+O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O
  54.   ObjectClass: COUtilityCruiseCar
  55.  
  56.   Summary:     COM Object Class for COUtilityCruiseCar COM Objects.
  57.                COM objects of this class augment COCruiseCar COM objects
  58.                with the IUtility interface features of Offroad and Winch.
  59.                COCruiseCar is reused to offer this COUtilityCruiseCar COM
  60.                Object the ICar interface features of Shift, Clutch, Speed,
  61.                Steer and the ICruise interface features of Engage and
  62.                Adjust.  This COUtilityCruiseCar COM object class is
  63.                constructed by aggregation reuse of the COCruiseCar COM
  64.                object class.  The mulitple interfaces on this COM object
  65.                class are constructed via the nested class
  66.                interfaces technique.
  67.  
  68.   Interfaces:  IUnknown
  69.                  Standard interface providing COM object features.
  70.                ICar
  71.                  Basic car features.
  72.                ICruise
  73.                  Cruise control system features.
  74.                IUtility
  75.                  Sport-utility Car operation features.  Implemented in
  76.                  this COM object.
  77.  
  78.   Aggregation: Yes, COUtilityCruiseCar COM objects are aggregatable by
  79.                passing a non-NULL pUnkOuter IUnknown pointer into
  80.                the constructor.
  81. O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O-O*/
  82. class COUtilityCruiseCar : public IUnknown
  83. {
  84.   public:
  85.     // Main Object Constructor & Destructor.
  86.     COUtilityCruiseCar(IUnknown* pUnkOuter);
  87.     ~COUtilityCruiseCar(void);
  88.  
  89.     // A general method for initializing a newly created UtilityCruiseCar.
  90.     HRESULT Init(void);
  91.  
  92.     // IUnknown members. Main object, non-delegating.
  93.     STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  94.     STDMETHODIMP_(ULONG) AddRef(void);
  95.     STDMETHODIMP_(ULONG) Release(void);
  96.  
  97.   private:
  98.     // We declare nested class interface implementations here.
  99.  
  100.     // We implement the IUtility interface (of course) in this
  101.     // COUtilityCruiseCar COM object class.  This is the native interface
  102.     // that we are using as an augmentation to the existing COCruiseCar
  103.     // COM object class.
  104.     class CImpIUtility : public IUtility
  105.     {
  106.       public:
  107.         // Interface Implementation Constructor & Destructor.
  108.         CImpIUtility(COUtilityCruiseCar* pBackObj, IUnknown* pUnkOuter);
  109.         ~CImpIUtility(void);
  110.  
  111.         // IUnknown members.
  112.         STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  113.         STDMETHODIMP_(ULONG) AddRef(void);
  114.         STDMETHODIMP_(ULONG) Release(void);
  115.  
  116.         // IUtility members.
  117.         STDMETHODIMP Offroad(short nGear);
  118.         STDMETHODIMP Winch(short nRpm);
  119.  
  120.       private:
  121.         // Data private to this interface implementation of IUtility.
  122.         ULONG               m_cRefI;     // Interface Ref Count (debugging).
  123.         COUtilityCruiseCar* m_pBackObj;  // Parent Object back pointer.
  124.         IUnknown*           m_pUnkOuter; // Outer unknown for Delegation.
  125.     };
  126.  
  127.     // Make the otherwise private and nested IUtility interface
  128.     // implementation a friend to COM object instantiations of this
  129.     // selfsame COUtilityCruiseCar COM object class.
  130.     friend CImpIUtility;
  131.  
  132.     // Private data of COUtilityCruiseCar COM objects.
  133.  
  134.     // Nested IUtility implementation instantiation.  This IUtility
  135.     // interface is instantiated inside this COUtilityCruiseCar object
  136.     // as a native interface.
  137.     CImpIUtility    m_ImpIUtility;
  138.  
  139.     // Main Object reference count.
  140.     ULONG           m_cRefs;
  141.  
  142.     // Outer unknown (aggregation delegation). Used when this
  143.     // COUtilityCruiseCar object is being aggregated.
  144.     IUnknown*       m_pUnkOuter;
  145.  
  146.     // We need to save the IUnknown interface pointer on the COCruiseCar
  147.     // object that we aggregate.  We use this when we need to delegate
  148.     // IUnknown calls to this aggregated inner object.
  149.     IUnknown*       m_pUnkCruiseCar;
  150. };
  151.  
  152. typedef COUtilityCruiseCar* PCOUtilityCruiseCar;
  153.  
  154. // Here is a prototpye for the UtilityCruiseCar Creation function.
  155. HRESULT CreateUtilityCruiseCar(
  156.           IUnknown* pUnkOuter,
  157.           REFIID riid,
  158.           PPVOID ppv);
  159.  
  160. #endif // __cplusplus
  161.  
  162.  
  163. #endif // UTCRUCAR_H
  164.