typedWritable.I

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file typedWritable.I
 * @author jason
 * @date 2000-06-08
 */

/**
 *
 */
INLINE TypedWritable::
TypedWritable() : _bam_writers(nullptr) {
}

/**
 *
 */
INLINE TypedWritable::
TypedWritable(const TypedWritable &) : _bam_writers(nullptr) {
}

/**
 *
 */
INLINE void TypedWritable::
operator = (const TypedWritable &) {
}

/**
 * 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.
 */
INLINE void TypedWritable::
mark_bam_modified() {
  ++_bam_modified;
}

/**
 * Returns the current bam_modified counter.  This counter is normally
 * incremented automatically whenever the object is modified.
 */
INLINE UpdateSeq TypedWritable::
get_bam_modified() const {
  return _bam_modified;
}

/**
 * Converts the TypedWritable object into a single stream of data using a
 * BamWriter, and returns that data as a bytes object.  Returns an empty bytes
 * object 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.
 */
INLINE vector_uchar TypedWritable::
encode_to_bam_stream() const {
  vector_uchar data;
  if (!encode_to_bam_stream(data)) {
    data.clear();
  }
  return data;
}