|
version 1.2, 2001/01/24 16:16:38
|
version 1.22, 2003/06/06 20:55:19
|
|
|
|
| /* 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 |
| |
|
| |
Fixed file name case for use on GNU/Linux: |
| |
Header file "StopWatch.h" is actually "Stopwatch.h" |
| |
"objectives.dxx" is actually "Objectives.dxx" |
| |
"Architecture.dxx" is actually "architecture.dxx" |
| |
"Components.dxx" is actually "components.dxx" |
| |
"installation.dxx" is actually "Installation.dxx" |
| |
"MOFCompiler.dxx" is actually "MOFcompiler.dxx" |
| |
"CIMObjects.dxx" is actually "cimobjects.dxx" |
| |
"CIMOBJECTTable.dxx" is actually "CIMobjectTable.dxx" |
| |
"Classes.dxx" is actually "classes.dxx" |
| |
"Interfaces.dxx" is actually "interfaces.dxx" |
| |
"FAQ.dxx" is actually "FAQ.DXX" |
| |
|
| $Log$ | $Log$ |
| Revision 1.2 2001/01/24 16:16:38 karl |
Revision 1.22 2003/06/06 20:55:19 karl |
| Incorporate Doc++ Comments as documentation into .h files |
update the controller for the Pegasus Developers manual in accord with the PEP to update documentation |
| |
|
| |
Revision 1.21 2002/02/16 17:38:44 kumpf |
| |
Modify Doc++ build environment to support Unix environments. |
| |
|
| |
Revision 1.20 2001/12/13 14:53:21 mike |
| |
Merged dev branch into main trunk. |
| |
|
| |
Revision 1.19.2.3 2001/10/05 21:16:41 kumpf |
| |
HP-RK Fix case for platforms with case-sensitive file names. |
| | |
| Revision 1.1 2001/01/24 14:18:48 karl |
Revision 1.19.2.2 2001/09/21 05:47:58 karl |
| import Dev Doc Files |
doc change to TOG formats |
| |
|
| |
Revision 1.19.2.1 2001/09/13 21:29:24 karl |
| |
Update to no Frame work |
| |
|
| |
Revision 1.19 2001/05/27 10:11:50 karl |
| |
Clean up object tables |
| |
|
| |
Revision 1.18 2001/05/21 17:33:33 karl |
| |
Update version number |
| | |
| | |
| $Author$ | $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>Welcome to PEGASUS</STRONG> |
<CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER> |
| | |
| 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. |
<P><B><CENTER>DRAFT FOR REVIEW</CENTER></B> |
| |
<SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL> |
| | |
| This manual serves as both a manual for operation of the prototype version of Pegasus |
Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. |
| and a manual for developing components to attach to Pegasus. |
|
| | |
| It includes information on the installation and operation of the broker and additional |
<B>This Document</B> |
| components. |
|
| | |
| In addition, it includes the current definition of the programming interfaces that |
<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. |
| Pegasus allows. As these interfaces are stabilized they will be moved from this |
|
| document to an Open Group specificaton. |
|
| | |
| Finally, this manual includes a number of defintions of additional code that is |
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 will find: |
| |
<UL> |
| |
<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>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. |
| |
<LI>A number of defintions of additional code that is |
| available to interface with Pegasus as providers, consumers, and services. | available to interface with Pegasus as providers, consumers, and services. |
| |
</UL> |
| | |
| This is not an internals manual for Pegasus. The Internals for Pegasus developers is |
<B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each. |
| defined in a separate manual that is also available from The Open Group |
|
| (\URL{http://www.opengroup.org}. |
|
| | |
| This version of the Pegasus User Manual was created at \today |
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}). |
| | |
| @memo An open-source implementation of the DMTF CIM Server by The Open Group |
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 |
| */ | */ |
| /* Change list to mvoe this into repository |
|
| Datetime - Done Comments need more work |
|
| String - Moved but comments need work |
|
| Name |
|
| Type |
|
| */ | */ |
| //@{ |
/* //@Include:DocumentHistory.dxx */ |
| |
/* The following is the complete file hiearchy for this document. |
| |
We have tried to keep all file references in only this one place |
| |
to make modification easier. In the future, please keep the |
| |
references here and text in the individual files. |
| |
*/ |
| |
|
| |
//@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: Interfaces.dxx |
|
| //@{ | //@{ |
| //@Include: ClientInterfaces.dxx |
//@Include: availability.dxx |
| |
//@Include: Installation.dxx |
| |
//@Include: operation.dxx |
| |
//@Include: CIMClients.dxx |
| |
//@Include: PegasusProviders.dxx |
| |
//@Include: MOFcompiler.dxx |
| |
//@} |
| |
//@Include: programming.dxx |
| //@{ | //@{ |
| //@Include: ..\..\src\Pegasus\Common\operations.h |
//@Include: cimobjects.dxx |
| |
//@Include: CIMobjectTable.dxx |
| |
//@Include: classes.dxx |
| |
//@{ |
| |
//@Include: ../../src/Pegasus/Common/Array.h |
| |
//@Include: ../../src/Pegasus/Common/Boolean.h |
| |
//@Include: ../../src/Pegasus/Common/CIMClass.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: data.dxx |
|
| //@{ | //@{ |
| //@Include: ..\..\src\Pegasus\Common\Array.h |
//@Include: Exceptions.dxx |
| //@Include: ..\..\src\Pegasus\Common\ClassDecl.h |
//@Include: ../../src/Pegasus/Common/Exception.h |
| //@Include: ..\..\src\Pegasus\Common\DateTime.h |
//@} |
| //@Include: ..\..\src\Pegasus\Common\QualifierDecl.h |
|
| //@Include: ..\..\src\Pegasus\Common\String.h |
|
| //@Include: ..\..\src\Pegasus\Common\Type.h |
|
| //@Include: ..\..\src\Pegasus\Common\InstanceDecl.h |
|
| //@Include: ..\..\src\Pegasus\Common\Value.h |
|
| //@Include: ..\..\src\Pegasus\Common\Property.h |
|
| //@Include: ..\..\src\Pegasus\Common\Scope.h |
|
| //@Include: ..\..\src\Pegasus\Common\Reference.h |
|
| //@Include: ..\..\src\Pegasus\Common\QualifierNames.h |
|
| //@Include: ..\..\src\Pegasus\Common\Qualifier.h |
|
| //@Include: ..\..\src\Pegasus\Common\Name.h |
|
| //@Include: ..\..\src\Pegasus\Common\Method.h |
|
| //@Include: ..\..\src\Pegasus\Common\Flavor.h |
|
| //@Include: ..\..\src\Pegasus\Common\Char16.h |
|
| //@} | //@} |
| |
|
| |
//@} |
| |
//@Include: interfaces.dxx |
| |
//@{ |
| |
//@Include: CIMOperations.dxx |
| |
//@{ |
| |
//@Include: ../../doc/CIMOperations.h |
| |
//@} |
| |
//@Include: ClientInterfaces.dxx |
| |
//@{ |
| |
//@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: ../../src/Pegasus/Repository/CIMRepository.h |
| |
//@} |
| //@} | //@} |
| | |
| //@Include: FAQ.dxx |
//@Include: ProviderWriting.dxx |
| //@Include: references.dxx |
|
| //@Include: definitions.dxx | //@Include: definitions.dxx |
| //@Include: Examples.dxx | //@Include: Examples.dxx |
| //@} |
|
| | |
| |
//@{ |
| |
//@Include: ExamplesClient.dxx |
| |
//@Include: ExamplesProvider.dxx |
| |
//@} |
| |
//@Include: references.dxx |
| |
//@Include: FAQ.DXX |
| | |
| | |
Return to
PegasusDoc.dxx
CVS log
Up to [Pegasus] / pegasus / doc / DevManual