# BamReader

from pandac.PandaModules import BamReader

Class : BamReader
Description : This is the fundamental interface for extracting binary objects from a Bam file, as generated by a BamWriter.
A Bam file can be thought of as a linear collection of objects. Each object is an instance of a class that inherits, directly or indirectly, from TypedWritable. The objects may include pointers to other objects within the Bam file; the BamReader automatically manages these (with help from code within each class) and restores the pointers correctly.
This is the abstract interface and does not specifically deal with disk files, but rather with a DatagramGenerator of some kind, which is simply a linear source of Datagrams. It is probably from a disk file, but it might conceivably be streamed directly from a network or some such nonsense.
Bam files are most often used to store scene graphs or subgraphs, and by convention they are given filenames ending in the extension ".bam" when they are used for this purpose. However, a Bam file may store any arbitrary list of TypedWritable objects; in this more general usage, they are given filenames ending in ".boo" to differentiate them from the more common scene graph files.
See also BamFile, which defines a higher-level interface to read and write Bam files on disk.

## Inheritance:

BamReader:

## Methods of BamReader:

BamReader (Constructor)
changePointer
getAuxData
getCurrentMajorVer
getCurrentMinorVer
getFileEndian
getFileMajorVer
getFileMinorVer
getFilename
getLoaderOptions
init
isEof
readObject
resolve
setAuxData
setLoaderOptions

BamReader BamReader::BamReader(DatagramGenerator *generator, Filename const &name = ("")); The primary interface for a caller. Description:

changePointer bool BamReader::change_pointer(TypedWritable const *orig_pointer, TypedWritable const *new_pointer); Description: Indicates that an object recently read from the bam stream should be replaced with a new object. Any future occurrences of the original object in the stream will henceforth return the new object instead. The return value is true if the replacement was successfully made, or false if the object was not read from the stream (or if change_pointer had already been called on it).

getAuxData BamReader::AuxData *BamReader::get_aux_data(TypedWritable *obj, string const &name) const; Description: Returns the pointer previously associated with the bam reader by a previous call to set_aux_data(), or NULL if data with the indicated key has not been set.

getCurrentMajorVer int BamReader::get_current_major_ver(void) const; Description: Returns the major version number of Bam files supported by the current code base. This must match get_file_major_ver() in order to successfully read a file.

getCurrentMinorVer int BamReader::get_current_minor_ver(void) const; Description: Returns the minor version number of Bam files supported by the current code base. This must match or exceed get_file_minor_ver() in order to successfully read a file.

getFileEndian BamEndian BamReader::get_file_endian(void) const; Description: Returns the endian preference indicated by the Bam file currently being read. This does not imply that every number is stored using the indicated convention, but individual objects may choose to respect this flag when recording data.

getFileMajorVer int BamReader::get_file_major_ver(void) const; Description: Returns the major version number of the Bam file currently being read.

getFileMinorVer int BamReader::get_file_minor_ver(void) const; Description: Returns the minor version number of the Bam file currently being read.

getFilename Filename const &BamReader::get_filename(void) const; Description: If a BAM is a file, then the BamReader should contain the name of the file. This enables the reader to interpret pathnames in the BAM as relative to the directory containing the BAM.

getLoaderOptions LoaderOptions const &BamReader::get_loader_options(void) const; Description: Returns the LoaderOptions passed to the loader when the model was requested, if any.

init bool BamReader::init(void); Description: Initializes the BamReader prior to reading any objects from its source. This includes reading the Bam header. This returns true if the BamReader successfully initialized, false otherwise.

isEof bool BamReader::is_eof(void) const; Description: Returns true if the reader has reached end-of-file, false otherwise. This call is only valid after a call to read_object().

readObject TypedWritable *BamReader::read_object(void); Description: Reads a single object from the Bam file. If the object type is known, a new object of the appropriate type is created and returned; otherwise, NULL is returned. NULL is also returned when the end of the file is reached. is_eof() may be called to differentiate between these two cases. This may be called repeatedly to extract out all the objects in the Bam file, but typically (especially for scene graph files, indicated with the .bam extension), only one object is retrieved directly from the Bam file: the root of the scene graph. The remaining objects will all be retrieved recursively by the first object. Note that the object returned may not yet be complete. In particular, some of its pointers may not be filled in; you must call resolve() to fill in all the available pointers before you can safely use any objects returned by read_object().

resolve bool BamReader::resolve(void); Description: This may be called at any time during processing of the Bam file to resolve all the known pointers so far. It is usually called at the end of the processing, after all objects have been read, which is generally the best time to call it. This must be called at least once after reading a particular object via get_object() in order to validate that object. The return value is true if all objects have been resolved, or false if some objects are still outstanding (in which case you will need to call resolve() again later).

setAuxData void BamReader::set_aux_data(TypedWritable *obj, string const &name, BamReader::AuxData *data); Description: Associates an arbitrary block of data with the indicated object (or NULL), and the indicated name. This is intended to provide a place for temporary storage for objects reading themselves from the bam file. To use it, inherit from BamReader::AuxData and store whatever data you like there. Then associate your AuxData with the object as it is being read with set_aux_data(). You may later set the aux data to NULL to remove it; or it will automatically be removed (and deleted) after finalize() is called for the object in question. If the TypedWritable pointer is NULL, the the aux data is stored globally for the BamReader in general. This pointer is available to any bam objects, and will not be automatically removed until the BamReader itself destructs. In either case, the name is just an arbitrary user-defined key. If there is already a data pointer stored for the obj/name pair, that data pointer will be replaced (and deleted).

setLoaderOptions void BamReader::set_loader_options(LoaderOptions const &options); Description: Specifies the LoaderOptions for this BamReader.