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:

Public Types
typedef pmap< std::string, RecorderBase * >	Recorders

Public Member Functions
	RecorderTable (const RecorderTable &copy)

void	add_recorder (const std::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 ()

RecorderBase *	get_recorder (const std::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 std::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 (std::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 ReferenceCount *	as_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...

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

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

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_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...

TypedObject &	operator= (const TypedObject &copy)=default

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

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 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 32 of file recorderTable.h.

Member Function Documentation

◆ add_recorder()

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

inline

Adds the named recorder to the set of recorders.

Definition at line 48 of file recorderTable.I.

Referenced by RecorderController::add_recorder().

◆ clear_flags()

void RecorderTable::clear_flags ( short flags )

Clears the given flags on all recorders.

Definition at line 131 of file recorderTable.cxx.

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

◆ get_recorder()

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

inline

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

Definition at line 67 of file recorderTable.I.

Referenced by 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 42 of file recorderTable.cxx.

References unref_delete().

Referenced by RecorderController::play_frame().