Panda3D
Public Member Functions | Static Public Member Functions

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

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

List of all members.

Public Member Functions

 addDependentFile (Filename const pathname)
 Adds the indicated file to the list of files that will be loaded to generate the data in this record.
 clearData ()
 Removes the in-memory data object associated with this record, if any.
 clearDependentFiles ()
 Empties the list of files that contribute to the data in this record.
bool dependentsUnchanged ()
 Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise.
string encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encodeToBamStream (basic_stringchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
bool encodeToBamStream (basic_stringchar data)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
UpdateSeq getBamModified ()
 Returns the current bam_modified counter.
Filename const getCacheFilename ()
 Returns the name of the cache file as hashed from the source_pathname.
TypedWritable getData ()
 Returns a pointer to the data stored in the record, or NULL if there is no data.
Filename const getDependentPathname (int n)
 Returns the full pathname of the nth source files that contributes to the cache.
int getNumDependentFiles ()
 Returns the number of source files that contribute to the cache.
unsigned int getRecordedTime ()
 Returns the time at which this particular record was recorded or updated.
int getRefCount ()
 Returns the current reference count.
Filename const getSourcePathname ()
 Returns the full pathname to the source file that originally generated this cache request.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool hasData ()
 Returns true if this cache record has an in-memory data object associated--that is, the object stored in the cache.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
BamCacheRecord makeCopy ()
 Returns a duplicate of the BamCacheRecord.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
bool operator== (BamCacheRecord const other)
 Returns true if the record matches the other record in those attributes which get written to disk.
 output (ostream out)
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
PyObject reducePersist (PyObject self, PyObject pickler)
 This special Python method is implement to provide support for the pickle module.
 ref ()
 Explicitly increments the reference count.
 setData (TypedWritable ptr, ReferenceCount ref_ptr)
 Stores a new data object on the record.
 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.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.
 write (ostream out, int indent_level)
 write (ostream out)

Static Public Member Functions

static TypedWritableReferenceCount decodeFromBamStream (string 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.
static TypedWritableReferenceCount decodeFromBamStream (string data)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
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 ( Filename const  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 ( )

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

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

clearDependentFiles ( )

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

static TypedWritableReferenceCount decodeFromBamStream ( string  data,
BamReader  reader 
) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

static TypedWritableReferenceCount decodeFromBamStream ( string  data) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

bool dependentsUnchanged ( )

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

string encodeToBamStream ( ) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data,
BamWriter  writer 
) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

UpdateSeq getBamModified ( ) [inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Filename const 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.

static TypeHandle getClassType ( ) [static]

Reimplemented from TypedWritableReferenceCount.

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.

Filename const getDependentPathname ( int  n)

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

int getNumDependentFiles ( )

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

unsigned int getRecordedTime ( )

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

int getRefCount ( ) [inherited]

Returns the current reference count.

Filename const 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.

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [inherited]

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

bool hasData ( )

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

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

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

markBamModified ( ) [inherited]

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.

bool operator== ( BamCacheRecord const  other)

Returns true if the record matches the other record in those attributes which get written to disk.

Does not compare the data pointer.

output ( ostream  out)
PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.

PyObject reducePersist ( PyObject  self,
PyObject  pickler 
) [inherited]

This special Python method is implement to provide support for the pickle module.

This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.

ref ( ) [inherited]

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

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 ( TypedWritable  ptr,
int  dummy 
)

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

bool testRefCountIntegrity ( ) [inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [inherited]

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

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

write ( ostream  out)
write ( ostream  out,
int  indent_level 
)
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties