RecorderHeader Class Reference

This object contains the header information written out at the beginning of a recorded session file. More...

#include "recorderHeader.h"

Inheritance diagram for RecorderHeader:

Public Member Functions
	RecorderHeader (const RecorderHeader &copy)
virtual TypeHandle	force_init_type ()
virtual TypeHandle	get_type () const
void	operator= (const RecorderHeader &copy)
virtual void	write_datagram (BamWriter *manager, Datagram &dg)
	Writes the contents of this object to the datagram for shipping out to a Bam file.
Public Member Functions inherited from TypedWritable
	TypedWritable (const TypedWritable &copy)
virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
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().
vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object.
bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
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.
UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter.
void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
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.
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.
Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default
TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer.
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.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
TypedObject &	operator= (const TypedObject &copy)=default
Public Member Functions inherited from MemoryBase
void	operator delete (void *, void *)
void	operator delete (void *ptr)
void	operator delete[] (void *, void *)
void	operator delete[] (void *ptr)
void *	operator new (size_t size)
void *	operator new (size_t size, void *ptr)
void *	operator new[] (size_t size)
void *	operator new[] (size_t size, void *ptr)

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 Lens.
Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes.
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.

Public Attributes
int	_random_seed
time_t	_start_time
Public Attributes inherited from TypedObject
	get_type

Additional Inherited Members
Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

This object contains the header information written out at the beginning of a recorded session file.

Definition at line 31 of file recorderHeader.h.

Constructor & Destructor Documentation

RecorderHeader() [1/2]

RecorderHeader::RecorderHeader ( )

inline

Definition at line 17 of file recorderHeader.I.

RecorderHeader() [2/2]

RecorderHeader::RecorderHeader ( const RecorderHeader & copy )

inline

Definition at line 26 of file recorderHeader.I.

~RecorderHeader()

RecorderHeader::~RecorderHeader ( )

inline

Definition at line 45 of file recorderHeader.I.

Member Function Documentation

force_init_type()

virtual TypeHandle RecorderHeader::force_init_type ( )

inlinevirtual

Reimplemented from TypedWritable.

Definition at line 61 of file recorderHeader.h.

get_class_type()

static TypeHandle RecorderHeader::get_class_type ( )

inlinestatic

Definition at line 50 of file recorderHeader.h.

get_type()

virtual TypeHandle RecorderHeader::get_type ( ) const

inlinevirtual

Reimplemented from TypedWritable.

Definition at line 58 of file recorderHeader.h.

init_type()

static void RecorderHeader::init_type ( )

inlinestatic

Definition at line 53 of file recorderHeader.h.

operator=()

void RecorderHeader::operator= ( const RecorderHeader & copy )

inline

Definition at line 36 of file recorderHeader.I.

register_with_read_factory()

void RecorderHeader::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type Lens.

Definition at line 25 of file recorderHeader.cxx.

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

write_datagram()

void RecorderHeader::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 34 of file recorderHeader.cxx.

References Datagram::add_int32(), Datagram::add_uint32(), and TypedWritable::write_datagram().

Member Data Documentation

_random_seed

int RecorderHeader::_random_seed

Definition at line 39 of file recorderHeader.h.

_start_time

time_t RecorderHeader::_start_time

Definition at line 38 of file recorderHeader.h.

---

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

• panda/src/recorder/recorderHeader.h
• panda/src/recorder/recorderHeader.cxx
• panda/src/recorder/recorderHeader.I