---

RothPipeline.c File Reference

#include "RothPipeline.h"

Go to the source code of this file.

Functions
RothPipeline*	InitRothPipelineEmpty ()
	Initilizes an empty RothPipeline. More...
int	RothPipelineSetDefaultValues (RothPipeline * rp)
	Clears RothPipeline to default values. More...
void	FreeRothPipeline (void * vptr)
	Frees memory associated with RothPipeline structure. More...

---

Detailed Description

Author(s):

Marco Morais

Date:

2000-2001

HFire (Highly Optmized Tolerance Fire Spread Model) Library Copyright (C) 2001 Marco Morais

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file RothPipeline.c.

---

Function Documentation

void FreeRothPipeline ( void * vptr )

Frees memory associated with RothPipeline structure. Subsequent calls to methods taking RothPipeline as argument will not work. See also: RothPipeline Parameters: vptr   ptr to RothPipeline Definition at line 65 of file RothPipeline.c. Referenced by FreeRothFuelModel().

RothPipeline * InitRothPipelineEmpty ( )

Initilizes an empty RothPipeline. See also: RothPipeline Return values: RothPipeline   * Ptr to RothPipeline structure attributes initilized to default values. Definition at line 27 of file RothPipeline.c. Referenced by InitRothFuelModelEmpty().

int RothPipelineSetDefaultValues ( RothPipeline * rp )

Clears RothPipeline to default values. Parameters: rp   RothPipeline which has already been initialized See also: RothPipeline Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 42 of file RothPipeline.c. Referenced by InitRothPipelineEmpty(), and Roth1972FireSpreadSetFuelBed().

---