/*
 * Portions of this file Copyright 1999-2005 University of Chicago
 * Portions of this file Copyright 1999-2005 The University of Southern California.
 *
 * This file or a portion of this file is licensed under the
 * terms of the Globus Toolkit Public License, found at
 * http://www.globus.org/toolkit/download/license.html.
 * If you redistribute this file, with or without
 * modifications, you must include this notice in the file.
 */


/*
 * This file is automatically generated by the Globus WSDLtoC converter
 */

#ifndef _WSMDS_JOBTYPE_ARRAY_H_
#define _WSMDS_JOBTYPE_ARRAY_H_

#include "globus_common.h"
#include "globus_xsd_type_info.h"

#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL
EXTERN_C_BEGIN
#endif /* GLOBUS_DONT_DOCUMENT_INTERNAL */

#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL

/* This is documented in the wsmds_JobType header. */

extern xsd_QName wsmds_JobType_qname;

#endif /* GLOBUS_DONT_DOCUMENT_INTERNAL */

/**
 * Array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 *
 * This structure type is used represent an array of
 * wsmds_JobType elements.
 *
 * Arrays are allocated by wsmds_JobType_array_init() and freed by calling
 * wsmds_JobType_array_destroy(). Elements may be added to an array by calling
 * wsmds_JobType_array_push().
 */
typedef struct wsmds_JobType_array_s
{
    /** Dynamic array of elements */
    struct wsmds_JobType_s * elements;
    /** Number of elements in this array */
    int length;
} wsmds_JobType_array;

/**
 * Initialize an array of wsmds_JobType elements.
 * @ingroup wsmds_JobType
 *
 * Allocates a new array of 0 elements. When this array is no longer used,
 * it should be freed by calling 
 * wsmds_JobType_array_destroy(). 
 *
 * @param inst
 *     Pointer to set to a newly allocated array instance.
 */
globus_result_t
wsmds_JobType_array_init(
    wsmds_JobType_array ** inst);

/**
 * Destroy an array of wsmds_JobType elements.
 * @ingroup wsmds_JobType
 *
 * Frees an array of wsmds_JobType elements. The contents of each element
 * element in the array be destroyed by calling
 * wsmds_JobType_destroy_contents().
 *
 * @param inst
 *     Pointer to array instance to destroy.
 */
void
wsmds_JobType_array_destroy(
    wsmds_JobType_array * inst);

/**
 * Copy an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 *
 * Perform a deep copy of an array of wsmds_JobType elements.
 * The @a dest array will be allocated, and then a copy of the contents
 * of each element in @a src will be made to @a dest.
 * 
 * @param dest
 *     Array to be initialized with copies of the elements in @a src.
 * @param src
 *     Source array to be copied.
 */
globus_result_t
wsmds_JobType_array_copy(
    wsmds_JobType_array ** dest,
    const wsmds_JobType_array * src);

/**
 * Initialize the contents of an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 *
 * Initialize the contents of an array of wsmds_JobType elements. Used
 * when the array is allocated on the stack or by a some allocator besides
 * wsmds_JobType_array_init(). The contents of the array may be freed
 * by calling wsmds_JobType_array_destroy_contents().
 *
 * @param inst
 *     Pointer to an allocated but uninitialized array.
 */
globus_result_t
wsmds_JobType_array_init_contents(
    wsmds_JobType_array * inst);

/**
 * Destroy the contents of an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 *
 * Destroy the elements in an array of wsmds_JobType elements. The contents of
 * each element in the array be destroyed by calling
 * wsmds_JobType_destroy_contents() and the array will be reset to be empty.
 *
 * @param inst
 *     Pointer to array instance to destroy.
 */
void
wsmds_JobType_array_destroy_contents(
    wsmds_JobType_array * inst);

/**
 * Copy the contents of an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 *
 * Perform a deep copy of an array of wsmds_JobType elements.
 * The @a dest array must be allocated before making this call.
 * A copy of the contents of each element in @a src will be made to @a dest.
 * 
 * @param dest
 *     Array to be initialized with copies of the elements in @a src.
 * @param src
 *     Source array to be copied.
 */
globus_result_t
wsmds_JobType_array_copy_contents(
    wsmds_JobType_array * dest,
    const wsmds_JobType_array * src);

/**
 * Append a new wsmds_JobType to an array
 * @ingroup wsmds_JobType
 *
 * Allocate and initialize a new wsmds_JobType structure, adding it
 * to the end of the given @a array.
 * 
 * @param array
 *     Array to be appended to.
 *
 * @return This function returns the newly allocated element.
 */
struct wsmds_JobType_s *
wsmds_JobType_array_push(
    wsmds_JobType_array * array);

/**
 * Serialize an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 * Serialize an element containing an array of wsmds_JobType elements.
 *
 * @param element
 *     The name of the element which will contain the array.
 * @param array_instance
 *     The array to serialize
 * @param message_handle
 *     The handle to serialize the element on.
 * @param options
 *     Serialization options.
 */
globus_result_t
wsmds_JobType_array_serialize(
    xsd_QName *                         element,
    wsmds_JobType_array * array_instance,
    globus_soap_message_handle_t        message_handle,
    globus_xsd_element_options_t        options);

/**
 * Deserialize an array of wsmds_JobType elements
 * @ingroup wsmds_JobType
 * Deserialize an element containing an array of wsmds_JobType elements.
 *
 * @param element
 *     The name of the element which should enclose the array.
 * @param array_instance
 *     The array to deserialize into
 * @param message_handle
 *     The handle to deserialize the element from.
 * @param options
 *     Deserialization options.
 */
globus_result_t
wsmds_JobType_array_deserialize(
    xsd_QName *                         element,
    wsmds_JobType_array * array_instance,
    globus_soap_message_handle_t        message_handle,
    globus_xsd_element_options_t        options);

    

#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL
void *
wsmds_JobType_array_push_wrapper(
    void * array);

globus_result_t
wsmds_JobType_array_serialize_wrapper(
    xsd_QName *                         element,
    void *                              instance,
    globus_soap_message_handle_t        message,
    globus_xsd_element_options_t        options);
    
globus_result_t
wsmds_JobType_array_deserialize_wrapper(
    xsd_QName *                         element_qname,
    void **                             inst,
    globus_soap_message_handle_t        message,
    globus_xsd_element_options_t        options);
    
globus_result_t
wsmds_JobType_array_init_wrapper(
    void **                             arr);
    
void
wsmds_JobType_array_destroy_wrapper(
    void *                              arr);
    
globus_result_t
wsmds_JobType_array_copy_wrapper(
    void **                             dest_arr,
    void *                              src_arr);

globus_result_t
wsmds_JobType_array_init_contents_wrapper(
    void *                              arr);
    
void
wsmds_JobType_array_destroy_contents_wrapper(
    void *                              arr);
    
globus_result_t
wsmds_JobType_array_copy_contents_wrapper(
    void *                              dest_arr,
    void *                              src_arr);

#endif /* GLOBUS_DONT_DOCUMENT_INTERNAL */
    
#ifndef GLOBUS_DONT_DOCUMENT_INTERNAL
EXTERN_C_END
#endif /* GLOBUS_DONT_DOCUMENT_INTERNAL */

#endif
