Panda3D
Public Member Functions | List of all members
DCAtomicField Class Reference

A single atomic field of a Distributed Class, as read from a .dc file. More...

#include "dcAtomicField.h"

Inheritance diagram for DCAtomicField:
DCField DCPackerInterface DCKeywordList

Public Member Functions

 DCAtomicField (const std::string &name, DCClass *dclass, bool bogus_field)
 
void add_element (DCParameter *element)
 Adds a new element (parameter) to the field. More...
 
virtual DCAtomicFieldas_atomic_field ()
 Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL. More...
 
virtual const DCAtomicFieldas_atomic_field () const
 Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL. More...
 
virtual void generate_hash (HashGenerator &hashgen) const
 Accumulates the properties of this field into the hash. More...
 
DCParameterget_element (int n) const
 Returns the parameter object describing the nth element. More...
 
vector_uchar get_element_default (int n) const
 Returns the pre-formatted default value associated with the nth element of the field. More...
 
int get_element_divisor (int n) const
 Returns the divisor associated with the nth element of the field. More...
 
std::string get_element_name (int n) const
 Returns the name of the nth element of the field. More...
 
DCSubatomicType get_element_type (int n) const
 Returns the numeric type of the nth element of the field. More...
 
virtual DCPackerInterfaceget_nested_field (int n) const
 Returns the DCPackerInterface object that represents the nth nested field. More...
 
int get_num_elements () const
 Returns the number of elements (parameters) of the atomic field. More...
 
bool has_element_default (int n) const
 Returns true if the nth element of the field has a default value specified, false otherwise. More...
 
virtual void output (std::ostream &out, bool brief) const
 
virtual void write (std::ostream &out, bool brief, int indent_level) const
 Generates a parseable description of the object to the indicated output stream. More...
 
- Public Member Functions inherited from DCField
 DCField (const std::string &name, DCClass *dclass)
 
virtual DCFieldas_field ()
 
virtual const DCFieldas_field () const
 
virtual DCMolecularFieldas_molecular_field ()
 Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL. More...
 
virtual const DCMolecularFieldas_molecular_field () const
 Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL. More...
 
virtual DCParameteras_parameter ()
 
virtual const DCParameteras_parameter () const
 
std::string format_data (const vector_uchar &packed_data, bool show_field_names=true)
 Given a blob that represents the packed data for this field, returns a string formatting it for human consumption. More...
 
DCClassget_class () const
 Returns the DCClass pointer for the class that contains this field. More...
 
const vector_uchar & get_default_value () const
 Returns the default value for this field. More...
 
int get_number () const
 Returns a unique index number associated with this field. More...
 
bool has_default_value () const
 Returns true if a default value has been explicitly established for this field, false otherwise. More...
 
bool is_airecv () const
 Returns true if the "airecv" flag is set for this field, false otherwise. More...
 
bool is_bogus_field () const
 Returns true if the field has been flagged as a bogus field. More...
 
bool is_broadcast () const
 Returns true if the "broadcast" flag is set for this field, false otherwise. More...
 
bool is_clrecv () const
 Returns true if the "clrecv" flag is set for this field, false otherwise. More...
 
bool is_clsend () const
 Returns true if the "clsend" flag is set for this field, false otherwise. More...
 
bool is_db () const
 Returns true if the "db" flag is set for this field, false otherwise. More...
 
bool is_ownrecv () const
 Returns true if the "ownrecv" flag is set for this field, false otherwise. More...
 
bool is_ownsend () const
 Returns true if the "ownsend" flag is set for this field, false otherwise. More...
 
bool is_ram () const
 Returns true if the "ram" flag is set for this field, false otherwise. More...
 
bool is_required () const
 Returns true if the "required" flag is set for this field, false otherwise. More...
 
void output (std::ostream &out) const
 Write a string representation of this instance to <out>. More...
 
virtual bool pack_default_value (DCPackData &pack_data, bool &pack_error) const
 Packs the field's specified default value (or a sensible default if no value is specified) into the stream. More...
 
vector_uchar parse_string (const std::string &formatted_string)
 Given a human-formatted string (for instance, as returned by format_data(), above) that represents the value of this field, parse the string and return the corresponding packed data. More...
 
void set_class (DCClass *dclass)
 Assigns the class pointer to this field. More...
 
void set_default_value (vector_uchar default_value)
 Establishes a default value for this field. More...
 
virtual void set_name (const std::string &name)
 Sets the name of this field. More...
 
void set_number (int number)
 Assigns the unique number to this field. More...
 
bool validate_ranges (const vector_uchar &packed_data) const
 Verifies that all of the packed values in the field data are within the specified ranges and that there are no extra bytes on the end of the record. More...
 
void write (std::ostream &out, int indent_level) const
 Write a string representation of this instance to <out>. More...
 
- Public Member Functions inherited from DCPackerInterface
 DCPackerInterface (const std::string &name=std::string())
 
 DCPackerInterface (const DCPackerInterface &copy)
 
virtual DCClassParameteras_class_parameter ()
 
virtual const DCClassParameteras_class_parameter () const
 
virtual DCSwitchParameteras_switch_parameter ()
 
virtual const DCSwitchParameteras_switch_parameter () const
 
virtual int calc_num_nested_fields (size_t length_bytes) const
 This flavor of get_num_nested_fields is used during unpacking. More...
 
bool check_match (const DCPackerInterface *other) const
 Returns true if the other interface is bitwise the same as this one–that is, a uint32 only matches a uint32, etc. More...
 
bool check_match (const std::string &description, DCFile *dcfile=nullptr) const
 Returns true if this interface is bitwise the same as the interface described with the indicated formatted string, e.g. More...
 
virtual bool do_check_match_array_parameter (const DCArrayParameter *other) const
 Returns true if this field matches the indicated array parameter, false otherwise. More...
 
virtual bool do_check_match_class_parameter (const DCClassParameter *other) const
 Returns true if this field matches the indicated class parameter, false otherwise. More...
 
virtual bool do_check_match_molecular_field (const DCMolecularField *other) const
 Returns true if this field matches the indicated molecular field, false otherwise. More...
 
virtual bool do_check_match_simple_parameter (const DCSimpleParameter *other) const
 Returns true if this field matches the indicated simple parameter, false otherwise. More...
 
virtual bool do_check_match_switch_parameter (const DCSwitchParameter *other) const
 Returns true if this field matches the indicated switch parameter, false otherwise. More...
 
int find_seek_index (const std::string &name) const
 Returns the index number to be passed to a future call to DCPacker::seek() to seek directly to the named field without having to look up the field name in a table later, or -1 if the named field cannot be found. More...
 
const DCPackerCatalogget_catalog () const
 Returns the DCPackerCatalog associated with this field, listing all of the nested fields by name. More...
 
size_t get_fixed_byte_size () const
 If has_fixed_byte_size() returns true, this returns the number of bytes this field type will use. More...
 
const std::string & get_name () const
 Returns the name of this field, or empty string if the field is unnamed. More...
 
size_t get_num_length_bytes () const
 Returns the number of bytes that should be written into the stream on a push() to record the number of bytes in the record up until the next pop(). More...
 
int get_num_nested_fields () const
 Returns the number of nested fields required by this field type. More...
 
DCPackType get_pack_type () const
 Returns the type of value expected by this field. More...
 
bool has_fixed_byte_size () const
 Returns true if this field type always packs to the same number of bytes, false if it is variable. More...
 
bool has_fixed_structure () const
 Returns true if this field type always has the same structure regardless of the data in the stream, or false if its structure may vary. More...
 
bool has_nested_fields () const
 Returns true if this field type has any nested fields (and thus expects a push() . More...
 
bool has_range_limits () const
 Returns true if this field, or any sub-field of this field, has a limit imposed in the DC file on its legal values. More...
 
virtual void pack_blob (DCPackData &pack_data, const vector_uchar &value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_double (DCPackData &pack_data, double value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_int (DCPackData &pack_data, int value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_int64 (DCPackData &pack_data, int64_t value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_string (DCPackData &pack_data, const std::string &value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_uint (DCPackData &pack_data, unsigned int value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void pack_uint64 (DCPackData &pack_data, uint64_t value, bool &pack_error, bool &range_error) const
 Packs the indicated numeric or string value into the stream. More...
 
virtual void unpack_blob (const char *data, size_t length, size_t &p, vector_uchar &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual void unpack_double (const char *data, size_t length, size_t &p, double &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual void unpack_int (const char *data, size_t length, size_t &p, int &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual void unpack_int64 (const char *data, size_t length, size_t &p, int64_t &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual bool unpack_skip (const char *data, size_t length, size_t &p, bool &pack_error) const
 Increments p to the end of the current field without actually unpacking any data or performing any range validation. More...
 
virtual void unpack_string (const char *data, size_t length, size_t &p, std::string &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual void unpack_uint (const char *data, size_t length, size_t &p, unsigned int &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual void unpack_uint64 (const char *data, size_t length, size_t &p, uint64_t &value, bool &pack_error, bool &range_error) const
 Unpacks the current numeric or string value from the stream. More...
 
virtual bool unpack_validate (const char *data, size_t length, size_t &p, bool &pack_error, bool &range_error) const
 Internally unpacks the current numeric or string value and validates it against the type range limits, but does not return the value. More...
 
virtual bool validate_num_nested_fields (int num_nested_fields) const
 After a number of fields have been packed via push() . More...
 
- Public Member Functions inherited from DCKeywordList
 DCKeywordList (const DCKeywordList &copy)
 
bool add_keyword (const DCKeyword *keyword)
 Adds the indicated keyword to the list. More...
 
void clear_keywords ()
 Removes all keywords from the field. More...
 
bool compare_keywords (const DCKeywordList &other) const
 Returns true if this list has the same keywords as the other list, false if some keywords differ. More...
 
void copy_keywords (const DCKeywordList &other)
 Replaces this keyword list with those from the other list. More...
 
void generate_hash (HashGenerator &hashgen) const
 Accumulates the properties of these keywords into the hash. More...
 
const DCKeywordget_keyword (int n) const
 Returns the nth keyword in the list. More...
 
const DCKeywordget_keyword_by_name (const std::string &name) const
 Returns the keyword in the list with the indicated name, or NULL if there is no keyword in the list with that name. More...
 
int get_num_keywords () const
 Returns the number of keywords in the list. More...
 
bool has_keyword (const std::string &name) const
 Returns true if this list includes the indicated keyword, false otherwise. More...
 
bool has_keyword (const DCKeyword *keyword) const
 Returns true if this list includes the indicated keyword, false otherwise. More...
 
void operator= (const DCKeywordList &copy)
 
void output_keywords (std::ostream &out) const
 

Additional Inherited Members

- Static Public Member Functions inherited from DCPackerInterface
static void do_pack_float64 (char *buffer, double value)
 
static void do_pack_int16 (char *buffer, int value)
 
static void do_pack_int32 (char *buffer, int value)
 
static void do_pack_int64 (char *buffer, int64_t value)
 
static void do_pack_int8 (char *buffer, int value)
 
static void do_pack_uint16 (char *buffer, unsigned int value)
 
static void do_pack_uint32 (char *buffer, unsigned int value)
 
static void do_pack_uint64 (char *buffer, uint64_t value)
 
static void do_pack_uint8 (char *buffer, unsigned int value)
 
static double do_unpack_float64 (const char *buffer)
 
static int do_unpack_int16 (const char *buffer)
 
static int do_unpack_int32 (const char *buffer)
 
static int64_t do_unpack_int64 (const char *buffer)
 
static int do_unpack_int8 (const char *buffer)
 
static unsigned int do_unpack_uint16 (const char *buffer)
 
static unsigned int do_unpack_uint32 (const char *buffer)
 
static uint64_t do_unpack_uint64 (const char *buffer)
 
static unsigned int do_unpack_uint8 (const char *buffer)
 
static void validate_int64_limits (int64_t value, int num_bits, bool &range_error)
 Confirms that the signed value fits within num_bits bits. More...
 
static void validate_int_limits (int value, int num_bits, bool &range_error)
 Confirms that the signed value fits within num_bits bits. More...
 
static void validate_uint64_limits (uint64_t value, int num_bits, bool &range_error)
 Confirms that the unsigned value fits within num_bits bits. More...
 
static void validate_uint_limits (unsigned int value, int num_bits, bool &range_error)
 Confirms that the unsigned value fits within num_bits bits. More...
 

Detailed Description

A single atomic field of a Distributed Class, as read from a .dc file.

This defines an interface to the Distributed Class, and is always implemented as a remote procedure method.

Definition at line 30 of file dcAtomicField.h.

Member Function Documentation

◆ add_element()

void DCAtomicField::add_element ( DCParameter element)

Adds a new element (parameter) to the field.

Normally this is called only during parsing. The DCAtomicField object becomes the owner of the new pointer and will delete it upon destruction.

Definition at line 222 of file dcAtomicField.cxx.

References DCPackerInterface::get_fixed_byte_size(), DCField::has_default_value(), DCPackerInterface::has_fixed_byte_size(), DCPackerInterface::has_fixed_structure(), and DCPackerInterface::has_range_limits().

◆ as_atomic_field() [1/2]

DCAtomicField * DCAtomicField::as_atomic_field ( )
virtual

Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL.

Reimplemented from DCField.

Definition at line 52 of file dcAtomicField.cxx.

◆ as_atomic_field() [2/2]

const DCAtomicField * DCAtomicField::as_atomic_field ( ) const
virtual

Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL.

Reimplemented from DCField.

Definition at line 61 of file dcAtomicField.cxx.

◆ generate_hash()

void DCAtomicField::generate_hash ( HashGenerator hashgen) const
virtual

Accumulates the properties of this field into the hash.

Reimplemented from DCField.

Definition at line 193 of file dcAtomicField.cxx.

References HashGenerator::add_int(), DCKeywordList::generate_hash(), and DCField::generate_hash().

◆ get_element()

DCParameter * DCAtomicField::get_element ( int  n) const

Returns the parameter object describing the nth element.

Definition at line 77 of file dcAtomicField.cxx.

◆ get_element_default()

vector_uchar DCAtomicField::get_element_default ( int  n) const

Returns the pre-formatted default value associated with the nth element of the field.

This is only valid if has_element_default() returns true, in which case this string represents the bytes that should be assigned to the field as a default value.

If the element is an array-type element, the returned value will include the two-byte length preceding the array data.

Definition at line 94 of file dcAtomicField.cxx.

◆ get_element_divisor()

int DCAtomicField::get_element_divisor ( int  n) const

Returns the divisor associated with the nth element of the field.

This implements an implicit fixed-point system; floating-point values are to be multiplied by this value before encoding into a packet, and divided by this number after decoding.

This method is deprecated; use get_element()->get_divisor() instead.

Definition at line 145 of file dcAtomicField.cxx.

◆ get_element_name()

string DCAtomicField::get_element_name ( int  n) const

Returns the name of the nth element of the field.

This name is strictly for documentary purposes; it does not generally affect operation. If a name is not specified, this will be the empty string.

Definition at line 119 of file dcAtomicField.cxx.

◆ get_element_type()

DCSubatomicType DCAtomicField::get_element_type ( int  n) const

Returns the numeric type of the nth element of the field.

This method is deprecated; use get_element() instead.

Definition at line 129 of file dcAtomicField.cxx.

◆ get_nested_field()

DCPackerInterface * DCAtomicField::get_nested_field ( int  n) const
virtual

Returns the DCPackerInterface object that represents the nth nested field.

This may return NULL if there is no such field (but it shouldn't do this if n is in the range 0 <= n < get_num_nested_fields()).

Reimplemented from DCPackerInterface.

Definition at line 211 of file dcAtomicField.cxx.

◆ get_num_elements()

int DCAtomicField::get_num_elements ( ) const

Returns the number of elements (parameters) of the atomic field.

Definition at line 69 of file dcAtomicField.cxx.

◆ has_element_default()

bool DCAtomicField::has_element_default ( int  n) const

Returns true if the nth element of the field has a default value specified, false otherwise.

Definition at line 106 of file dcAtomicField.cxx.

◆ write()

void DCAtomicField::write ( std::ostream &  out,
bool  brief,
int  indent_level 
) const
virtual

Generates a parseable description of the object to the indicated output stream.

Implements DCField.

Definition at line 179 of file dcAtomicField.cxx.

References indent().


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