Panda3D
Public Member Functions | Static Public Member Functions | List of all members
DataNodeTransmit Class Reference

Encapsulates the data generated from (or sent into) any particular DataNode. More...

#include "dataNodeTransmit.h"

Inheritance diagram for DataNodeTransmit:
TypedWritable TypedObject MemoryBase

Public Member Functions

 DataNodeTransmit (const DataNodeTransmit &copy)
 
virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
virtual TypeHandle force_init_type ()
 
const EventParameterget_data (int index) const
 Extracts the data for the indicated index, if it has been stored, or the empty parameter if it has not. More...
 
virtual TypeHandle get_type () const
 
bool has_data (int index) const
 Returns true if the indicated parameter has been stored, false otherwise. More...
 
void operator= (const DataNodeTransmit &copy)
 
void reserve (int num_wires)
 Tells the DataNodeTransmit object how many wires it is expected to store data for. More...
 
void set_data (int index, const EventParameter &data)
 Sets the data for the indicated parameter. More...
 
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...
 
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
 
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...
 
TypedObjectoperator= (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...
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
 get_type
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

Encapsulates the data generated from (or sent into) any particular DataNode.

This is basically just an array of EventParameters, one for each registered input or output wire.

Definition at line 32 of file dataNodeTransmit.h.

Member Function Documentation

◆ complete_pointers()

int DataNodeTransmit::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
virtual

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 68 of file dataNodeTransmit.cxx.

◆ get_data()

const EventParameter & DataNodeTransmit::get_data ( int  index) const
inline

Extracts the data for the indicated index, if it has been stored, or the empty parameter if it has not.

Definition at line 52 of file dataNodeTransmit.I.

◆ has_data()

bool DataNodeTransmit::has_data ( int  index) const
inline

Returns true if the indicated parameter has been stored, false otherwise.

Definition at line 64 of file dataNodeTransmit.I.

◆ register_with_read_factory()

void DataNodeTransmit::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type Lens.

Definition at line 42 of file dataNodeTransmit.cxx.

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

◆ reserve()

void DataNodeTransmit::reserve ( int  num_wires)
inline

Tells the DataNodeTransmit object how many wires it is expected to store data for.

Definition at line 43 of file dataNodeTransmit.I.

Referenced by DriveInterface::force_dgraph(), and DataNode::transmit_data().

◆ set_data()

void DataNodeTransmit::set_data ( int  index,
const EventParameter data 
)
inline

Sets the data for the indicated parameter.

Definition at line 75 of file dataNodeTransmit.I.

Referenced by DriveInterface::force_dgraph().

◆ write_datagram()

void DataNodeTransmit::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 51 of file dataNodeTransmit.cxx.

References Datagram::add_uint16(), EventParameter::get_ptr(), TypedWritable::write_datagram(), and BamWriter::write_pointer().


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