BamCacheRecord

class BamCacheRecord

Bases: TypedWritableReferenceCount, LinkedListNode

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.

Inheritance diagram

void add_dependent_file(Filename const &pathname)

void add_dependent_file(VirtualFile const *file)

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.

Variant of add_dependent_file that takes an already opened VirtualFile.

void clear_data(void)

Removes the in-memory data object associated with this record, if any. This does not affect the on-disk representation of the record.

void clear_dependent_files(void)

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

bool dependents_unchanged(void) const

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

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. 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).

Filename const &get_cache_filename(void) const

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.

static TypeHandle get_class_type(void)

TypedWritable *get_data(void) const

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.

Filename const &get_dependent_pathname(int n) const

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

int get_num_dependent_files(void) const

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

time_t get_recorded_time(void) const

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

Filename const &get_source_pathname(void) const

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.

time_t get_source_timestamp(void) const

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.

bool has_data(void) const

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

PointerTo<BamCacheRecord> make_copy(void) const

Returns a duplicate of the BamCacheRecord. The duplicate will not have a data pointer set, even though one may have been assigned to the original via set_data().

void output(std::ostream &out) const

void set_data(TypedWritable *ptr, ReferenceCount *ref_ptr)

void set_data(TypedWritable *ptr)

void set_data(TypedWritableReferenceCount *ptr)

void set_data(TypedWritable *ptr, int dummy)

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.

This variant on set_data() is provided to easily pass objects deriving from TypedWritable.

This variant on set_data() is provided to easily pass objects deriving from TypedWritableReferenceCount.

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

void write(std::ostream &out, int indent_level = 0) const