version 1.8, 2001/02/06 17:02:13
|
version 1.23, 2005/12/14 18:38:54
|
|
|
/* PegasusDoc.dxx - Top Level file for Developer Documentation. | /* PegasusDoc.dxx - Top Level file for Developer Documentation. |
This file defines the document strucuture and provides the introduction | This file defines the document strucuture and provides the introduction |
$Log$ |
|
Revision 1.8 2001/02/06 17:02:13 karl |
|
rearrange documentation for interfaces |
|
| |
Revision 1.7 2001/02/05 14:14:00 karl |
|
doc++ extension for respository |
|
|
|
Revision 1.6 2001/02/02 19:38:23 karl |
|
add graphic |
|
|
|
Revision 1.5 2001/02/02 18:48:20 karl |
|
Doc++ expansion |
|
|
|
Revision 1.4 2001/01/30 23:38:18 karl |
|
Add to documentation |
|
|
|
Revision 1.3 2001/01/24 17:17:05 karl |
|
add Doc++ comments |
|
|
|
Revision 1.2 2001/01/24 16:16:38 karl |
|
Incorporate Doc++ Comments as documentation into .h files |
|
|
|
Revision 1.1 2001/01/24 14:18:48 karl |
|
import Dev Doc Files |
|
|
|
|
|
$Author$ |
|
*/ | */ |
/** @name Pegasus |
/* do not change the following Name. Used in the Frame definition. |
|
If you change it, the HTML Frame must also be changed. |
|
*/ |
|
/** @name Introduction |
| |
<STRONG><B>Welcome to PEGASUS</B></STRONG> |
<CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER> |
| |
<P><B>DRAFT FOR REVIEW</B> |
<P><B><CENTER>DRAFT FOR REVIEW</CENTER></B> |
<P>Version 1.5, 01/02/02</P> |
<SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL> |
<P>Version 1.6 01/04/02 - Clean up the API defintions. and Add repository section. |
|
| |
Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. | Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. |
| |
|
|
| |
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. | 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. |
| |
Within this manual you should find: |
Within this manual you will find: |
<UL> | <UL> |
<LI>Information on the installation and operation of the broker and additional components. | <LI>Information on the installation and operation of the broker and additional components. |
<LI> A basic defintion of the architecture and function of Pegasus. | <LI> A basic defintion of the architecture and function of Pegasus. |
|
|
available to interface with Pegasus as providers, consumers, and services. | available to interface with Pegasus as providers, consumers, and services. |
</UL> | </UL> |
| |
<B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each. |
<B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each. |
| |
This is not an internals manual for Pegasus. The Internals for Pegasus developers will be defined in a separate manual that is also available from The Open Group (\URL{http://www.opengroup.org/Management}. |
This is not an internals manual for Pegasus. The Internals for Pegasus developers will be defined in a separate manual that will be available from The Open Group (\URL{http://www.opengroup.org/management}). |
| |
NOTE: This a working document today. It is revised frequently as we learn more about the documentation system and stabilize the Pegasus interfaces. We apologize for the existing insonsistencies and errors in this working version of the document. | NOTE: This a working document today. It is revised frequently as we learn more about the documentation system and stabilize the Pegasus interfaces. We apologize for the existing insonsistencies and errors in this working version of the document. |
| |
This version of the Pegasus User Manual was created at \today | This version of the Pegasus User Manual was created at \today |
*/ | */ |
| |
/* |
|
Table stuff to see if it worksl |
|
|
|
<table border cellspacing=0 cellpadding=5> |
|
<tr> |
|
<td colspan=2 rowspan=2></td> |
|
<th colspan=2 align=center>Preferences></th> |
|
</tr> |
|
<tr> |
|
<th>Eating Kumquats</th> |
|
<th>poke int he eye</th> |
|
</tr> |
|
</table> |
|
*/ | */ |
|
/* //@Include:DocumentHistory.dxx */ |
/* Change list to mvoe this into repository |
/* The following is the complete file hiearchy for this document. |
Datetime - Done Comments need more work |
We have tried to keep all file references in only this one place |
String - Moved but comments need work |
to make modification easier. In the future, please keep the |
Name |
references here and text in the individual files. |
Type |
|
Property |
|
Reference |
|
Value |
|
Union - First comments in |
|
*/ | */ |
//@{ |
|
//@Include: objectives.dxx |
//@Include: Objectives.dxx |
//@Include: overview.dxx | //@Include: overview.dxx |
//@Include: credits.dxx | //@Include: credits.dxx |
//@Include: Architecture.dxx |
//@Include: architecture.dxx |
//@Include: Components.dxx |
//@Include: components.dxx |
//@Include: Utilization.dxx | //@Include: Utilization.dxx |
//@Include: CIMOBJECTS.dxx |
|
//@{ | //@{ |
//@Include: ..\..\src\Pegasus\Common\Array.h |
//@Include: availability.dxx |
//@Include: ..\..\src\Pegasus\Common\ClassDecl.h |
//@Include: Installation.dxx |
//@Include: ..\..\src\Pegasus\Common\DateTime.h |
//@Include: operation.dxx |
//@Include: ..\..\src\Pegasus\Common\QualifierDecl.h |
//@Include: CIMClients.dxx |
//@Include: ..\..\src\Pegasus\Common\String.h |
//@Include: PegasusProviders.dxx |
//@Include: ..\..\src\Pegasus\Common\Type.h |
//@Include: MOFcompiler.dxx |
//@Include: ..\..\src\Pegasus\Common\InstanceDecl.h |
//@} |
//@Include: ..\..\src\Pegasus\Common\Value.h |
//@Include: programming.dxx |
//@Include: ..\..\src\Pegasus\Common\Property.h |
//@{ |
//@Include: ..\..\src\Pegasus\Common\Scope.h |
//@Include: cimobjects.dxx |
//@Include: ..\..\src\Pegasus\Common\Reference.h |
//@Include: CIMobjectTable.dxx |
//@Include: ..\..\src\Pegasus\Common\QualifierNames.h |
//@Include: classes.dxx |
//@Include: ..\..\src\Pegasus\Common\Qualifier.h |
//@{ |
//@Include: ..\..\src\Pegasus\Common\Name.h |
//@Include: ../../src/Pegasus/Common/Array.h |
//@Include: ..\..\src\Pegasus\Common\Method.h |
//@Include: ../../src/Pegasus/Common/Boolean.h |
//@Include: ..\..\src\Pegasus\Common\Flavor.h |
//@Include: ../../src/Pegasus/Common/CIMClass.h |
//@Include: ..\..\src\Pegasus\Common\Char16.h |
//@Include: ../../src/Pegasus/Common/CIMClassRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMDateTime.h |
|
//@Include: ../../src/Pegasus/Common/CIMExceptionRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMFlavor.h |
|
//@Include: ../../src/Pegasus/Common/CIMIndication.h |
|
//@Include: ../../src/Pegasus/Common/CIMInstance.h |
|
//@Include: ../../src/Pegasus/Common/CIMInstanceRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMMessage.h |
|
//@Include: ../../src/Pegasus/Common/CIMMethod.h |
|
//@Include: ../../src/Pegasus/Common/CIMMethodRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMName.h |
|
//@Include: ../../src/Pegasus/Common/CIMOMPort.h |
|
//@Include: ../../src/Pegasus/Common/CIMObject.h |
|
//@Include: ../../src/Pegasus/Common/CIMObjectPath.h |
|
//@Include: ../../src/Pegasus/Common/CIMObjectRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMParamValue.h |
|
//@Include: ../../src/Pegasus/Common/CIMParamValueRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMParameter.h |
|
//@Include: ../../src/Pegasus/Common/CIMParameterRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMPredicate.h |
|
//@Include: ../../src/Pegasus/Common/CIMProperty.h |
|
//@Include: ../../src/Pegasus/Common/CIMPropertyList.h |
|
//@Include: ../../src/Pegasus/Common/CIMPropertyRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifier.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifierDeclRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifierList.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifierNames.h |
|
//@Include: ../../src/Pegasus/Common/CIMQualifierRep.h |
|
//@Include: ../../src/Pegasus/Common/CIMRepositoryBase.h |
|
//@Include: ../../src/Pegasus/Common/CIMScope.h |
|
//@Include: ../../src/Pegasus/Common/CIMStatusCode.h |
|
//@Include: ../../src/Pegasus/Common/CIMType.h |
|
//@Include: ../../src/Pegasus/Common/CIMValue.h |
|
//@Include: ../../src/Pegasus/Common/Char16.h |
|
//@Include: ../../src/Pegasus/Common/Formatter.h |
|
//@Include: ../../src/Pegasus/Common/OperationContext.h |
|
//@Include: ../../src/Pegasus/Common/Queue.h |
|
//@Include: ../../src/Pegasus/Common/Stopwatch.h |
|
//@Include: ../../src/Pegasus/Common/String.h |
|
|
|
//@{ |
|
//@Include: Exceptions.dxx |
|
//@Include: ../../src/Pegasus/Common/Exception.h |
|
//@} |
//@} | //@} |
//@Include: Interfaces.dxx |
|
|
//@} |
|
//@Include: interfaces.dxx |
//@{ | //@{ |
//@Include: CIMOperations.dxx | //@Include: CIMOperations.dxx |
//@{ | //@{ |
//@Include: ..\..\src\Pegasus\Common\Operations.h |
//@Include: ../../doc/CIMOperations.h |
//@} | //@} |
//@Include: ClientInterfaces.dxx | //@Include: ClientInterfaces.dxx |
//@{ | //@{ |
//@Include: ..\..\src\Pegasus\Client\Client.h |
//@Include: ../../src/Pegasus/Client/CIMClient.h |
//@} | //@} |
//@Include: ProviderInterfaces.dxx | //@Include: ProviderInterfaces.dxx |
|
//@{ |
| |
|
//@Include: ../../src/Pegasus/Provider/CIMProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMClassProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h |
|
//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMNullProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h |
|
//@Include: ../../src/Pegasus/Provider/CIMPropertyProvider.h |
|
//@Include: ../../src/Pegasus/Provider/CIMQueryProvider.h |
|
//@Include: ../../src/Pegasus/Provider/ProviderException.h |
|
//@} |
//@Include: ServiceInterfaces.dxx | //@Include: ServiceInterfaces.dxx |
//@Include: RepositoryInterfaces.dxx | //@Include: RepositoryInterfaces.dxx |
//@{ | //@{ |
//@Include: ..\..\src\Pegasus\Repository\Repository.h |
//@Include: ../../src/Pegasus/Repository/CIMRepository.h |
//@} | //@} |
//@} | //@} |
| |
//@Include: ProviderWriting.dxx | //@Include: ProviderWriting.dxx |
//@Include: definitions.dxx | //@Include: definitions.dxx |
//@Include: Examples.dxx | //@Include: Examples.dxx |
//@Include: references.dxx |
|
//@Include: FAQ.dxx |
|
//@} |
|
| |
|
//@{ |
|
//@Include: ExamplesClient.dxx |
|
//@Include: ExamplesProvider.dxx |
|
//@} |
|
//@Include: references.dxx |
|
//@Include: FAQ.DXX |
| |
| |