write_realization_settings Struct Reference

Settings for write_realization function. More...

List of all members.

Public Member Functions

 write_realization_settings ()
 Default constructor.

Public Attributes

std::string version
 A version string.
std::string header
 A header for the file.

Detailed Description

Settings for write_realization function.

Author:
RevKit
Since:
1.0

Constructor & Destructor Documentation

Default constructor.

Initializes default values

Author:
RevKit
Since:
1.0

Member Data Documentation

std::string header

A header for the file.

This header will be printed as a comment in the first lines of the file. The string can be multi-line seperated by \n escape sequences. The comment character # can be omitted and will be inserted automatically.

Example

The following code creates a header in beginning of the file with author information.

 circuit circ;

 write_realization_settings settings;
 settings.header = "Author: Test User\n(c) University";
 write_realization( circ, "circuit.real", settings );
Author:
RevKit
Since:
1.0
std::string version

A version string.

Default value is 1.0 and printed after .version command

Author:
RevKit
Since:
1.0

The documentation for this struct was generated from the following file:

Generated on Fri Jul 2 07:50:42 2010 for by doxygen 1.6.3