Panda3D
Loading...
Searching...
No Matches
dcArrayParameter.h
Go to the documentation of this file.
1/**
2 * PANDA 3D SOFTWARE
3 * Copyright (c) Carnegie Mellon University. All rights reserved.
4 *
5 * All use of this software is subject to the terms of the revised BSD
6 * license. You should have received a copy of this license along
7 * with this source code in a file named "LICENSE."
8 *
9 * @file dcArrayParameter.h
10 * @author drose
11 * @date 2004-06-17
12 */
13
14#ifndef DCARRAYPARAMETER_H
15#define DCARRAYPARAMETER_H
16
17#include "dcbase.h"
18#include "dcParameter.h"
19#include "dcNumericRange.h"
20
21/**
22 * This represents an array of some other kind of object, meaning this
23 * parameter type accepts an arbitrary (or possibly fixed) number of nested
24 * fields, all of which are of the same type.
25 */
26class EXPCL_DIRECT_DCPARSER DCArrayParameter : public DCParameter {
27public:
28 DCArrayParameter(DCParameter *element_type,
31 virtual ~DCArrayParameter();
32
33PUBLISHED:
34 virtual DCArrayParameter *as_array_parameter();
35 virtual const DCArrayParameter *as_array_parameter() const;
36 virtual DCParameter *make_copy() const;
37 virtual bool is_valid() const;
38
39 DCParameter *get_element_type() const;
40 int get_array_size() const;
41
42public:
44
45 virtual int calc_num_nested_fields(size_t length_bytes) const;
46 virtual DCPackerInterface *get_nested_field(int n) const;
47 virtual bool validate_num_nested_fields(int num_nested_fields) const;
48
49 virtual void output_instance(std::ostream &out, bool brief, const std::string &prename,
50 const std::string &name, const std::string &postname) const;
51 virtual void generate_hash(HashGenerator &hashgen) const;
52 virtual void pack_string(DCPackData &pack_data, const std::string &value,
53 bool &pack_error, bool &range_error) const;
54 virtual void pack_blob(DCPackData &pack_data, const vector_uchar &value,
55 bool &pack_error, bool &range_error) const;
56 virtual bool pack_default_value(DCPackData &pack_data, bool &pack_error) const;
57 virtual void unpack_string(const char *data, size_t length, size_t &p,
58 std::string &value, bool &pack_error, bool &range_error) const;
59 virtual void unpack_blob(const char *data, size_t length, size_t &p,
60 vector_uchar &value, bool &pack_error, bool &range_error) const;
61
62protected:
63 virtual bool do_check_match(const DCPackerInterface *other) const;
64 virtual bool do_check_match_simple_parameter(const DCSimpleParameter *other) const;
65 virtual bool do_check_match_class_parameter(const DCClassParameter *other) const;
66 virtual bool do_check_match_array_parameter(const DCArrayParameter *other) const;
67
68private:
69 DCParameter *_element_type;
70 int _array_size;
71 DCUnsignedIntRange _array_size_range;
72};
73
74#endif
This represents an array of some other kind of object, meaning this parameter type accepts an arbitra...
This represents a class (or struct) object used as a parameter itself.
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 s...
Definition dcField.cxx:487
This is a block of data that receives the results of DCPacker.
Definition dcPackData.h:22
This defines the internal interface for packing values into a DCField.
virtual void unpack_blob(const char *data, size_t length, size_t &p, std::vector< unsigned char > &value, bool &pack_error, bool &range_error) const
Unpacks the current numeric or string value from the stream.
virtual int calc_num_nested_fields(size_t length_bytes) const
This flavor of get_num_nested_fields is used during unpacking.
virtual bool do_check_match_simple_parameter(const DCSimpleParameter *other) const
Returns true if this field matches the indicated simple parameter, false otherwise.
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.
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.
virtual bool validate_num_nested_fields(int num_nested_fields) const
After a number of fields have been packed via push() .
virtual DCPackerInterface * get_nested_field(int n) const
Returns the DCPackerInterface object that represents the nth nested field.
virtual bool do_check_match_class_parameter(const DCClassParameter *other) const
Returns true if this field matches the indicated class parameter, false otherwise.
virtual bool do_check_match_array_parameter(const DCArrayParameter *other) const
Returns true if this field matches the indicated array parameter, false otherwise.
virtual void pack_blob(DCPackData &pack_data, const std::vector< unsigned char > &value, bool &pack_error, bool &range_error) const
Packs the indicated numeric or string value into the stream.
Represents the type specification for a single parameter within a field specification.
Definition dcParameter.h:35
virtual void generate_hash(HashGenerator &hashgen) const
Accumulates the properties of this type into the hash.
virtual DCParameter * append_array_specification(const DCUnsignedIntRange &size)
Returns the type represented by this_type[size].
This is the most fundamental kind of parameter type: a single number or string, one of the DCSubatomi...
This class generates an arbitrary hash number from a sequence of ints.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.