rq_fpml_product.h

风险财务控制库 Risk Quantify is an open source financial library, with a focus on managing the risk of fi

/*
** rq_fpml_product.h
**
** Written by Brett Hutley - [e-mail]
**
** Copyright (C) 2001 Brett Hutley
**
** This file is part of the Risk Quantify Library
**
** Risk Quantify is free software; you can redistribute it and/or
** modify it under the terms of the GNU Library General Public
** License as published by the Free Software Foundation; either
** version 2 of the License, or (at your option) any later version.
**
** Risk Quantify is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
** Library General Public License for more details.
**
** You should have received a copy of the GNU Library General Public
** License along with Risk Quantify; if not, write to the Free
** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
#ifndef rq_fpml_product_h
#define rq_fpml_product_h

/* -- includes ----------------------------------------------------- */
#include "rq_config.h"
#include "rq_defs.h"
#include "rq_stream.h"

/* -- prototypes --------------------------------------------------- */
RQ_DECLARE_OBJECT(rq_fpml_product_t);

/**
 * This function should only be called by a product-specific allocator.
 */
rq_fpml_product_t 
_rq_fpml_product_alloc(
    const char *product_type, 
    void *product_data,
    int (*write_xml_func)(void *, rq_stream_t),
    void (*free_func)(void *)
    );


/**
 * Free the memory allocated for a product (including the product-specific 
 * data).
 *
 * @param	product	The product data to free.
 */
void rq_fpml_product_free(rq_fpml_product_t product);

/**
 * Get the product-specific data pointer. This function should only be called by a product implementation.
 *
 * @param	product	The product to get the product-specific data pointer for
 * @return	The product-specific data pointer.
 */
void *_rq_fpml_product_get_product_data(rq_fpml_product_t product);

/**
 * Output a product in XML format to a stream
 *
 * @param	product	The product to output
 * @param	output_stream	The stream to write to
 * @return	The number of charaters written, or a negative status on error
 */
int rq_fpml_product_write_xml(rq_fpml_product_t product, rq_stream_t output_stream);


#endif