head 1.3; access; symbols; locks; strict; comment @# @; 1.3 date 2002.09.07.01.50.39; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.19.01.56; author curt; state Exp; branches; next 1.1; 1.1 date 2002.08.31.18.54.03; author curt; state Exp; branches; next ; desc @@ 1.3 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# props_io.hxx File Reference

Interface definition for property list io. More...

`#include <simgear/compiler.h>`
`#include <simgear/misc/props.hxx>`
`#include <stdio.h>`
`#include <vector>`
`#include <map>`

Go to the source code of this file.

## Functions
| SG_USING_STD (string)
| SG_USING_STD (vector)
| SG_USING_STD (map)
| SG_USING_STD (istream)
| SG_USING_STD (ostream)
void | readProperties (istream &input, SGPropertyNode *start_node, const string &base="")
| Read properties from an XML input stream.
void | readProperties (const string &file, SGPropertyNode *start_node)
| Read properties from an XML file.
void | writeProperties (ostream &output, const SGPropertyNode *start_node, bool write_all=false)
| Write properties to an XML output stream.
void | writeProperties (const string &file, const SGPropertyNode *start_node, bool write_all=false)
| Write properties to an XML file.
bool | copyProperties (const SGPropertyNode *in, SGPropertyNode *out)
| Copy properties from one node to another.

## Detailed Description

Interface definition for property list io.

Started Fall 2000 by David Megginson, david@@megginson.com This code is released into the Public Domain.

See props.html for documentation [replace with URL when available].

Id:
  props_io.hxx,v 1.1 2002/03/15 23:16:46 david Exp

Definition in file props_io.hxx.

## Function Documentation

bool copyProperties | ( | const SGPropertyNode * | in,
|  | SGPropertyNode * | out
| ) |

  | Copy properties from one node to another. Parameters:
  in | The source property tree.
  out | The destination property tree.
Returns: true if all properties were copied, false if some failed (for example, if the property's value is tied read-only). Definition at line 523 of file props_io.cxx.

void readProperties | ( | const string & | file,
|  | SGPropertyNode * | start_node
| ) |

  | Read properties from an XML file. Parameters:
  file | A string containing the file path.
  start_node | The root node for reading properties.
Returns: true if the read succeeded, false otherwise. Definition at line 310 of file props_io.cxx.

@ 1.2 log @Oops, try again. @ text @d163 1 a163 1