rq_fpml_exchange_rate.h

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

/*
** rq_fpml_exchange_rate.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_exchange_rate_h
#define rq_fpml_exchange_rate_h

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

/* -- structures --------------------------------------------------- */
struct rq_fpml_exchange_rate {
    const char *currency1;
    const char *currency2;
    enum rq_quote_basis quote_basis;
    double rate;
};

/* -- prototypes --------------------------------------------------- */


/**
 * Initialize an exchange rate structure by setting all its values to defaults/NULLs
 *
 * @param	exchange_rate	The exchange rate structure to initialize
 */
void rq_fpml_exchange_rate_init(struct rq_fpml_exchange_rate *exchange_rate);


/**
 * Fill out the values of an exchange structure. The strings are
 * copied onto the heap.
 *
 * @param	exchange_rate	The exchange rate structure
 * @param	currency1	The currency1 value (this string will be strdup()'ed and then managed by the structure.
 * @param	currency2	The currency2 value (this string will be strdup()'ed and then managed by the structure.
 * @param	quote_basis	The quote basis
 * @param rate The exchange rate itself 
*/
void rq_fpml_exchange_rate_fill(struct rq_fpml_exchange_rate *exchange_rate, const char *currency1, const char *currency2, enum rq_quote_basis quote_basis, double rate);


/**
 * Free any memory managed by this exchange rate structure (but NOT
 * deallocating the exchange rate structure itself), and set it's
 * members to default values.
 *
 * @param exchange_rate The exchange rate structure to clear.  
*/
void rq_fpml_exchange_rate_clear(struct rq_fpml_exchange_rate *exchange_rate);

int rq_fpml_exchange_rate_write_xml(struct rq_fpml_exchange_rate *p, rq_stream_t output_stream);

#endif