Panda3D
 All Classes Functions Variables Enumerations
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
BamCacheRecord Class Reference

An instance of this class is written to the front of a Bam or Txo file to make the file a cached instance of some other loadable resource. More...

#include "bamCacheRecord.h"

Inheritance diagram for BamCacheRecord:
TypedWritableReferenceCount LinkedListNode TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

void add_dependent_file (const Filename &pathname)
 Adds the indicated file to the list of files that will be loaded to generate the data in this record. More...
 
void clear_data ()
 Removes the in-memory data object associated with this record, if any. More...
 
void clear_dependent_files ()
 Empties the list of files that contribute to the data in this record. More...
 
bool dependents_unchanged () const
 Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise. More...
 
bool extract_data (TypedWritable *&ptr, ReferenceCount *&ref_ptr)
 Fills ptr and ref_ptr with the two different-typed pointers to the same object, the data stored within this record. More...
 
virtual TypeHandle force_init_type ()
 
const Filenameget_cache_filename () const
 Returns the name of the cache file as hashed from the source_pathname. More...
 
TypedWritableget_data () const
 Returns a pointer to the data stored in the record, or NULL if there is no data. More...
 
const Filenameget_dependent_pathname (int n) const
 Returns the full pathname of the nth source files that contributes to the cache. More...
 
int get_num_dependent_files () const
 Returns the number of source files that contribute to the cache. More...
 
time_t get_recorded_time () const
 Returns the time at which this particular record was recorded or updated. More...
 
const Filenameget_source_pathname () const
 Returns the full pathname to the source file that originally generated this cache request. More...
 
time_t get_source_timestamp () const
 Returns the file timestamp of the original source file that generated this cache record, if available. More...
 
virtual TypeHandle get_type () const
 
bool has_data () const
 Returns true if this cache record has an in-memory data object associated–that is, the object stored in the cache. More...
 
bool operator== (const BamCacheRecord &other) const
 
void output (ostream &out) const
 
 PT (BamCacheRecord) make_copy() const
 
void set_data (TypedWritable *ptr, ReferenceCount *ref_ptr)
 Stores a new data object on the record. More...
 
void set_data (TypedWritable *ptr, int dummy)
 This variant on set_data() is provided just to allow Python code to pass a 0 as the second parameter. More...
 
void write (ostream &out, int indent_level=0) const
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type BamCacheRecord. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Friends

class BamCache
 
class BamCacheIndex
 
class BamCacheRecord::SortByAccessTime
 

Additional Inherited Members

- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

An instance of this class is written to the front of a Bam or Txo file to make the file a cached instance of some other loadable resource.

This record contains information needed to test the validity of the cache.

Definition at line 38 of file bamCacheRecord.h.

Member Function Documentation

void BamCacheRecord::add_dependent_file ( const Filename pathname)

Adds the indicated file to the list of files that will be loaded to generate the data in this record.

This should be called once for the primary source file, and again for each secondary source file, if any.

Definition at line 167 of file bamCacheRecord.cxx.

References VirtualFileSystem::get_file(), VirtualFileSystem::get_global_ptr(), and Filename::make_absolute().

void BamCacheRecord::clear_data ( )
inline

Removes the in-memory data object associated with this record, if any.

This does not affect the on-disk representation of the record.

Definition at line 139 of file bamCacheRecord.I.

Referenced by extract_data(), and set_data().

void BamCacheRecord::clear_dependent_files ( )

Empties the list of files that contribute to the data in this record.

Definition at line 153 of file bamCacheRecord.cxx.

bool BamCacheRecord::dependents_unchanged ( ) const

Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise.

Definition at line 97 of file bamCacheRecord.cxx.

References VirtualFileSystem::get_file(), VirtualFileSystem::get_global_ptr(), and get_source_pathname().

bool BamCacheRecord::extract_data ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr 
)
inline

Fills ptr and ref_ptr with the two different-typed pointers to the same object, the data stored within this record.

This transfers ownership of the data pointer; the caller will be responsible for managing the reference counts on this object subsequently.

Returns true if the record contained any data (and the pointers have been filled), false if it didn't (and the pointers are NULL).

Definition at line 174 of file bamCacheRecord.I.

References clear_data().

const Filename & BamCacheRecord::get_cache_filename ( ) const
inline

Returns the name of the cache file as hashed from the source_pathname.

This will be relative to the root of the cache directory, and it will not include any suffixes that may be appended to resolve hash conflicts.

Definition at line 68 of file bamCacheRecord.I.

TypedWritable * BamCacheRecord::get_data ( ) const
inline

Returns a pointer to the data stored in the record, or NULL if there is no data.

The pointer is not removed from the record.

Definition at line 156 of file bamCacheRecord.I.

Referenced by BamCache::store().

const Filename & BamCacheRecord::get_dependent_pathname ( int  n) const
inline

Returns the full pathname of the nth source files that contributes to the cache.

Definition at line 114 of file bamCacheRecord.I.

int BamCacheRecord::get_num_dependent_files ( ) const
inline

Returns the number of source files that contribute to the cache.

Definition at line 103 of file bamCacheRecord.I.

time_t BamCacheRecord::get_recorded_time ( ) const
inline

Returns the time at which this particular record was recorded or updated.

Definition at line 92 of file bamCacheRecord.I.

const Filename & BamCacheRecord::get_source_pathname ( ) const
inline

Returns the full pathname to the source file that originally generated this cache request.

In some cases, for instance in the case of a of a multipage texture like "cube_#.png", this may not not a true filename on disk.

Definition at line 54 of file bamCacheRecord.I.

Referenced by dependents_unchanged().

time_t BamCacheRecord::get_source_timestamp ( ) const
inline

Returns the file timestamp of the original source file that generated this cache record, if available.

In some cases the original file timestamp is not available, and this will return 0.

Definition at line 81 of file bamCacheRecord.I.

bool BamCacheRecord::has_data ( ) const
inline

Returns true if this cache record has an in-memory data object associated–that is, the object stored in the cache.

Definition at line 127 of file bamCacheRecord.I.

Referenced by BamCache::store().

void BamCacheRecord::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type BamCacheRecord.

Definition at line 265 of file bamCacheRecord.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

void BamCacheRecord::set_data ( TypedWritable ptr,
ReferenceCount ref_ptr 
)
inline

Stores a new data object on the record.

You should pass the same pointer twice, to both parameters; this allows the C++ typecasting to automatically convert the pointer into both a TypedWritable and a ReferenceCount pointer, so that the BamCacheRecord object can reliably manage the reference counts.

You may pass 0 or NULL as the second parameter. If you do this, the BamCacheRecord will not manage the object's reference count; it will be up to you to ensure the object is not deleted during the lifetime of the BamCacheRecord object.

Definition at line 198 of file bamCacheRecord.I.

References clear_data(), and ReferenceCount::ref().

Referenced by DXTextureContext9::create_texture(), and set_data().

void BamCacheRecord::set_data ( TypedWritable ptr,
int  dummy 
)
inline

This variant on set_data() is provided just to allow Python code to pass a 0 as the second parameter.

Definition at line 216 of file bamCacheRecord.I.

References set_data().

void BamCacheRecord::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from TypedWritable.

Definition at line 276 of file bamCacheRecord.cxx.

References Datagram::add_string(), Datagram::add_uint16(), Datagram::add_uint32(), Datagram::add_uint64(), and TypedWritable::write_datagram().


The documentation for this class was generated from the following files: