1 karl  1.1 /* api.dxx - Top Level file for Developer api Documentation.
  2           This file defines the document strucuture and provides the introduction
  3           
  4           	
  5           	$Author: karl $
  6           */
  7           /* do not change the following Name.  Used in the Frame definition.
  8           If you change it, the HTML Frame must also be changed.
  9           */
 10           /** @name Introduction
 11           
 12           <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>
 13           
 14           <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
 15           <SMALL><CENTER>version 1.01 13 September 2003</CENTER></SMALL>
 16           
 17           Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 18           
 19           <B>This Document</B>
 20           
 21           <P>This is a working document that is the temporary user and developers manual for the Pegasus CIM Server implementation which is being created by the OpenGroup Enterprise Management Program Group.
 22 karl  1.1 
 23           This manual serves as both a manual for installation and operation of the prototype version of Pegasus and a manual for developing components to attach to Pegasus. In addition to the manual, we keep current working information in a set of README files within the Pegasus distributions. Please consult these files also.
 24           
 25           Within this manual you will find:
 26           <UL>
 27           <LI>Information on the installation and operation of the broker and additional components.
 28           <LI> A basic defintion of the architecture and function of Pegasus.
 29           <LI>The current definition of the programming interfaces that Pegasus allows.  As these interfaces are stabilized they will be moved from this document to an Open Group specificaton.
 30           <LI>A number of defintions of additional code that is
 31           available to interface with Pegasus as providers, consumers, and services.
 32           </UL>
 33           
 34           */
 35           
 36           
 37           /* The following is the complete file hiearchy for this document.
 38              We have tried to keep all file references in only this one place
 39              to make modification easier.  In the future, please keep the
 40              references here and text in the individual files.
 41              
 42           TBD: Pegasus API version information
 43 karl  1.1 */
 44           
 45           /** @name Pegasus CIM OBjects and General Function APIs
 46           	NOTE: This needs to be reorganized to take into account a structure for these APIs 
 47           */    
 48                   //@{
 49                      //@{ 
 50           		//@Include: ../../src/Pegasus/Common/Array.h
 51           		//@Include: ../../src/Pegasus/Common/Boolean.h
 52           		//@Include: ../../src/Pegasus/Common/CIMClass.h
 53           		//@Include: ../../src/Pegasus/Common/CIMClassRep.h
 54           		//@Include: ../../src/Pegasus/Common/CIMDateTime.h
 55           		//@Include: ../../src/Pegasus/Common/CIMExceptionRep.h
 56           		//@Include: ../../src/Pegasus/Common/CIMFlavor.h
 57           		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 58           		//@Include: ../../src/Pegasus/Common/CIMInstance.h
 59           		//@Include: ../../src/Pegasus/Common/CIMInstanceRep.h
 60           		//@Include: ../../src/Pegasus/Common/CIMMessage.h
 61           		//@Include: ../../src/Pegasus/Common/CIMMethod.h
 62           		//@Include: ../../src/Pegasus/Common/CIMMethodRep.h
 63           		//@Include: ../../src/Pegasus/Common/CIMName.h
 64 karl  1.1 		//@Include: ../../src/Pegasus/Common/CIMOMPort.h
 65           		//@Include: ../../src/Pegasus/Common/CIMObject.h
 66           		//@Include: ../../src/Pegasus/Common/CIMObjectPath.h
 67           		//@Include: ../../src/Pegasus/Common/CIMObjectRep.h
 68           		//@Include: ../../src/Pegasus/Common/CIMParamValue.h
 69           		//@Include: ../../src/Pegasus/Common/CIMParamValueRep.h
 70           		//@Include: ../../src/Pegasus/Common/CIMParameter.h
 71           		//@Include: ../../src/Pegasus/Common/CIMParameterRep.h
 72           		//@Include: ../../src/Pegasus/Common/CIMPredicate.h
 73           		//@Include: ../../src/Pegasus/Common/CIMProperty.h
 74           		//@Include: ../../src/Pegasus/Common/CIMPropertyList.h
 75           		//@Include: ../../src/Pegasus/Common/CIMPropertyRep.h
 76           		//@Include: ../../src/Pegasus/Common/CIMQualifier.h
 77           		//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
 78           		//@Include: ../../src/Pegasus/Common/CIMQualifierDeclRep.h
 79           		//@Include: ../../src/Pegasus/Common/CIMQualifierList.h
 80           		//@Include: ../../src/Pegasus/Common/CIMQualifierNames.h
 81           		//@Include: ../../src/Pegasus/Common/CIMQualifierRep.h
 82           		//@Include: ../../src/Pegasus/Common/CIMRepositoryBase.h
 83           		//@Include: ../../src/Pegasus/Common/CIMScope.h
 84           		//@Include: ../../src/Pegasus/Common/CIMStatusCode.h
 85 karl  1.1 		//@Include: ../../src/Pegasus/Common/CIMType.h
 86           		//@Include: ../../src/Pegasus/Common/CIMValue.h
 87           		//@Include: ../../src/Pegasus/Common/Char16.h
 88           		//@Include: ../../src/Pegasus/Common/Formatter.h
 89           		//@Include: ../../src/Pegasus/Common/OperationContext.h
 90           		//@Include: ../../src/Pegasus/Common/Queue.h
 91           		//@Include: ../../src/Pegasus/Common/Stopwatch.h
 92           		//@Include: ../../src/Pegasus/Common/String.h
 93           
 94                   	//@{
 95           		/// @name Exceptions  
 96                   	//@Include: ../../src/Pegasus/Common/Exception.h
 97                   	//@}
 98                       //@}
 99                   	
100           	//@}
101               /// @name Client and Provider Interfaces
102                  //@{
103           	    /** @name Pegasus Operations
104           	    NOTE That this section should probably go away
105           	    */
106 karl  1.1 	        //@{
107           		    //@Include: ../../doc/CIMOperations.h
108           		//@}
109           	    /// @name Pegasus Client Interfaces   
110           		//@{    
111           		    //@Include: ../../src/Pegasus/Client/CIMClient.h
112           		//@}
113               	   /// @name Pegasus Provider Interfaces
114               	   	//@{
115           
116           			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
117           			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
118           			//@Include: ../../src/Pegasus/Provider/CIMClassProvider.h
119           			//@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h
120           			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
121           			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
122           			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
123           			//@Include: ../../src/Pegasus/Provider/CIMNullProvider.h
124           			//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
125           			//@Include: ../../src/Pegasus/Provider/CIMPropertyProvider.h
126           			//@Include: ../../src/Pegasus/Provider/CIMQueryProvider.h
127 karl  1.1 			//@Include: ../../src/Pegasus/Provider/ProviderException.h
128           		//@}  	 
129                  //@}
130           /** @name Document References
131           
132           This section will contain references to external documents.
133           
134           NOTE: documents we must reference include:
135           
136           <UL>
137           	<LI>DMTF Specifications
138           	<LI>
139           </UL/
140           */    //@Include: references.dxx
141            
142