Panda3D
Public Member Functions | Static Public Member Functions | 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. This record contains information needed to test the validity of the cache. More...

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

Public Member Functions

 addDependentFile (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. More...
 
 clearData ()
 Removes the in-memory data object associated with this record, if any. This does not affect the on-disk representation of the record. More...
 
 clearDependentFiles ()
 Empties the list of files that contribute to the data in this record. More...
 
bool dependentsUnchanged ()
 Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise. More...
 
const Filename getCacheFilename ()
 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. More...
 
TypedWritable getData ()
 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. More...
 
const Filename getDependentPathname (int n)
 Returns the full pathname of the nth source files that contributes to the cache. More...
 
int getNumDependentFiles ()
 Returns the number of source files that contribute to the cache. More...
 
time_t getRecordedTime ()
 Returns the time at which this particular record was recorded or updated. More...
 
const Filename getSourcePathname ()
 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. More...
 
time_t getSourceTimestamp ()
 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. More...
 
bool hasData ()
 Returns true if this cache record has an in-memory data object associated–that is, the object stored in the cache. More...
 
BamCacheRecord makeCopy ()
 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(). More...
 
bool operator== (const BamCacheRecord other)
 
 output (Ostream out)
 
 setData (TypedWritable ptr, ReferenceCount ref_ptr)
 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. More...
 
 setData (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...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

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.

Member Function Documentation

◆ addDependentFile()

addDependentFile ( 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.

◆ clearData()

clearData ( )

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

◆ clearDependentFiles()

clearDependentFiles ( )

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

◆ dependentsUnchanged()

bool dependentsUnchanged ( )

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

◆ getCacheFilename()

const Filename getCacheFilename ( )

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.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getData()

TypedWritable getData ( )

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.

◆ getDependentPathname()

const Filename getDependentPathname ( int  n)

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

◆ getNumDependentFiles()

int getNumDependentFiles ( )

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

◆ getRecordedTime()

time_t getRecordedTime ( )

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

◆ getSourcePathname()

const Filename getSourcePathname ( )

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.

◆ getSourceTimestamp()

time_t getSourceTimestamp ( )

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.

◆ hasData()

bool hasData ( )

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

◆ makeCopy()

BamCacheRecord makeCopy ( )

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

◆ operator==()

bool operator== ( const BamCacheRecord  other)

◆ output()

output ( Ostream  out)

◆ setData() [1/2]

setData ( TypedWritable  ptr,
ReferenceCount  ref_ptr 
)

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.

◆ setData() [2/2]

setData ( TypedWritable  ptr,
int  dummy 
)

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

◆ write()

write ( Ostream  out,
int  indent_level 
)