TSE3::File::XmlLoadInfo Struct Reference

#include <XML.h>

Collaboration diagram for TSE3::File::XmlLoadInfo:

[legend]List of all members.

Public Member Functions
	XmlLoadInfo ()
Public Attributes
int	PPQN
Song *	song
int	major
int	minor
bool	unknownChunks
bool	unknownData
size_t	noChunks
Progress *	progress

---

Detailed Description

Data structure used by the Serializable class during loading. It contains information that has been gained about the file, mostly from the "Header" chunk. Most Serializable classes will not need to write to this struct, but will almost certainly need to read it (at least to convert local file PPQN resolution to TSE3 system PPQN).

---

Constructor & Destructor Documentation

TSE3::File::XmlLoadInfo::XmlLoadInfo (   )

Sets up some default values for the struct values. These are: PPQN - Clock::PPQN song - 0 major - -1 minor - -1 unknownChunks - false unknownData - false progress - 0

---

Member Data Documentation

int TSE3::File::XmlLoadInfo::PPQN

The PPQN resolution of timestamps in this file. You can use this to convert timestamps to the correct values in use in the TSE3 library. See Clock's convert() method. This information is read from the file's "Header" chunk.

Song* TSE3::File::XmlLoadInfo::song

The current Song. This is set once by the TSE3MDL class. You may not write over this value afterwards or you will create undefined behaviour.

int TSE3::File::XmlLoadInfo::major

The files's najor version number, read from it's "Header" chunk. This should be informational since the TSE3MDL file format is forwards and backwards compatible. The (invalid) value -1 means that no major version has been read.

int TSE3::File::XmlLoadInfo::minor

The file's minor version number, read from it's "Header" chunk. This should be informational since the TSE3MDL file format is forwards and backwards compatible. The (invalid) value -1 means that no minor version has been read.

bool TSE3::File::XmlLoadInfo::unknownChunks

A boolean flag which reports whether the loading encountered any unknown chunks (which will have been skipped over). If you are not using the FileBlockParser class to perform parsing, you must set this flag to true if you come across any unrecognised chunks. The FileBlockParser class does this automatically.

bool TSE3::File::XmlLoadInfo::unknownData

A boolean flag which reports whether the loading encountered any unknown data lines (which will have been ignored). If you are not using the FileBlockParser class to perform parsing, you must set this flag to true if you come across any unrecognised data lines. The FileBlockParser class does this automatically.

size_t TSE3::File::XmlLoadInfo::noChunks

A counter which reports how many chunks (and sub-chunks) were in the file. If you are not using the FileBlockParser class to perform parsing, you must increment this counter if you come across a new chunk. The FileBlockParser class does this automatically.

Progress* TSE3::File::XmlLoadInfo::progress

If the operation that triggered this serializable operation provided a Progress callback object, this points to it. This information is used by the FileBlockParser utility. You do not need to handle this in client code.

---

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

• /home/pete/Work/TSE3.svn/tse3/src/tse3/file/XML.h

---