Return to SCMOInternalXmlEncoder.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

BUG#:9400
TITLE: Add pointers to Single Chunk Memory Object Model design documents in code

DESCRIPTION:

//%LICENSE////////////////////////////////////////////////////////////////
//
// Licensed to The Open Group (TOG) under one or more contributor license
// agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
// this work for additional information regarding copyright ownership.
// Each contributor licenses this file to you under the OpenPegasus Open
// Source License; you may not use this file except in compliance with the
// License.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////
//
// This code implements part of PEP#348 - The CMPI infrastructure using SCMO
// (Single Chunk Memory Objects).
// The design document can be found on the OpenPegasus website openpegasus.org
// at https://collaboration.opengroup.org/pegasus/pp/documents/21210/PEP_348.pdf
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_SCMOInternalXmlEncoder_h
#define Pegasus_SCMOInternalXmlEncoder_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/CIMMessage.h>
#include <Pegasus/Common/CIMBuffer.h>

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_COMMON_LINKAGE SCMOInternalXmlEncoder
{
public:
    static void _putXMLInstance(
        CIMBuffer& out,
        const SCMOInstance& ci,
        const CIMPropertyList& propertyList = CIMPropertyList());
    static void _putXMLNamedInstance(
        CIMBuffer& out,
        const Array<SCMOInstance> & _scmoInstances,    
        const CIMPropertyList& propertyList = CIMPropertyList());
    static void _putXMLObject(
        CIMBuffer& out,
        const Array<SCMOInstance> & co,
        const CIMPropertyList& propertyList = CIMPropertyList());
    static void _appendValueReferenceElement(
        Buffer& out,
        const SCMOInstance& ref);

};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_SCMOInternalXmlEncoder_h */