Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
RecorderTable Class Reference

This object is used by the RecorderController to write (and read) a record of the set of recorders in use to the bam file. More...

#include "recorderTable.h"

Inheritance diagram for RecorderTable:
TypedWritable TypedObject MemoryBase

Public Types

typedef pmap< string, RecorderBase * > Recorders
 

Public Member Functions

 RecorderTable (const RecorderTable &copy)
 
void add_recorder (const string &name, RecorderBase *recorder)
 Adds the named recorder to the set of recorders. More...
 
void clear_flags (short flags)
 Clears the given flags on all recorders. More...
 
virtual TypeHandle force_init_type ()
 
RecorderBaseget_recorder (const string &name) const
 Returns the recorder with the indicated name, or NULL if there is no such recorder. More...
 
virtual TypeHandle get_type () const
 
void merge_from (const RecorderTable &other)
 Combines the data in the current table (presumably just read from disk, and matching exactly with the disk data) with the data in the indicated table, specified by the user (which may not exactly match the disk data). More...
 
void operator= (const RecorderTable &copy)
 
void play_frame (DatagramIterator &scan, BamReader *manager)
 Calls play_frame on all recorders. More...
 
void record_frame (BamWriter *manager, Datagram &dg)
 Calls record_frame on all recorders. More...
 
bool remove_recorder (const string &name)
 Removes the named recorder from the table. More...
 
void set_flags (short flags)
 Sets the given flags on all recorders. More...
 
void write (ostream &out, int indent_level) 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 TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
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)
 

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

Public Attributes

bool _error
 
Recorders _recorders
 

Additional Inherited Members

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

Detailed Description

This object is used by the RecorderController to write (and read) a record of the set of recorders in use to the bam file.

Do not attempt to use it directly.

Definition at line 35 of file recorderTable.h.

Member Function Documentation

◆ add_recorder()

void RecorderTable::add_recorder ( const string &  name,
RecorderBase recorder 
)
inline

Adds the named recorder to the set of recorders.

Definition at line 58 of file recorderTable.I.

References get_recorder().

Referenced by RecorderController::add_recorder().

◆ clear_flags()

void RecorderTable::clear_flags ( short  flags)

Clears the given flags on all recorders.

Definition at line 144 of file recorderTable.cxx.

References register_with_read_factory().

Referenced by RecorderController::close(), RecorderController::play_frame(), and set_flags().

◆ get_recorder()

RecorderBase * RecorderTable::get_recorder ( const string &  name) const
inline

Returns the recorder with the indicated name, or NULL if there is no such recorder.

Definition at line 79 of file recorderTable.I.

References remove_recorder().

Referenced by add_recorder(), RecorderController::get_recorder(), RecorderController::has_recorder(), and RecorderController::remove_recorder().

◆ merge_from()

void RecorderTable::merge_from ( const RecorderTable other)

Combines the data in the current table (presumably just read from disk, and matching exactly with the disk data) with the data in the indicated table, specified by the user (which may not exactly match the disk data).

Definition at line 47 of file recorderTable.cxx.

References record_frame().

Referenced by RecorderController::play_frame().

◆ play_frame()

void RecorderTable::play_frame ( DatagramIterator scan,
BamReader manager 
)

Calls play_frame on all recorders.

Definition at line 112 of file recorderTable.cxx.

References RecorderBase::play_frame(), and set_flags().

Referenced by RecorderFrame::play_frame(), and record_frame().

◆ record_frame()

void RecorderTable::record_frame ( BamWriter manager,
Datagram dg 
)

Calls record_frame on all recorders.

Definition at line 96 of file recorderTable.cxx.

References play_frame(), and RecorderBase::record_frame().

Referenced by merge_from(), and RecorderFrame::write_datagram().

◆ register_with_read_factory()

void RecorderTable::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type Lens.

Definition at line 180 of file recorderTable.cxx.

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

Referenced by clear_flags().

◆ remove_recorder()

bool RecorderTable::remove_recorder ( const string &  name)
inline

Removes the named recorder from the table.

Returns true if successful, false if there was no such recorder.

Definition at line 95 of file recorderTable.I.

Referenced by get_recorder(), and RecorderController::remove_recorder().

◆ set_flags()

void RecorderTable::set_flags ( short  flags)

Sets the given flags on all recorders.

Definition at line 128 of file recorderTable.cxx.

References clear_flags().

Referenced by RecorderController::begin_record(), play_frame(), and RecorderController::play_frame().

◆ write_datagram()

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

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