Panda3D
Public Member Functions | Friends | List of all members
DCClass Class Reference

Defines a particular DistributedClass as read from an input .dc file. More...

#include "dcClass.h"

Inheritance diagram for DCClass:
DCDeclaration

Public Member Functions

 DCClass (DCFile *dc_file, const std::string &name, bool is_struct, bool bogus_class)
 
bool add_field (DCField *field)
 Adds the newly-allocated field to the class. More...
 
void add_parent (DCClass *parent)
 Adds a new parent to the inheritance hierarchy of the class. More...
 
virtual DCClassas_class ()
 
virtual const DCClassas_class () const
 
void clear_inherited_fields ()
 Empties the list of inherited fields for the class, so that it may be rebuilt. More...
 
void generate_hash (HashGenerator &hashgen) const
 Accumulates the properties of this class into the hash. More...
 
DCFieldget_constructor () const
 Returns the constructor method for this class if it is defined, or NULL if the class uses the default constructor. More...
 
DCFileget_dc_file () const
 Returns the DCFile object that contains the class. More...
 
DCFieldget_field (int n) const
 Returns the nth field in the class. More...
 
DCFieldget_field_by_index (int index_number) const
 Returns a pointer to the DCField that has the indicated index number. More...
 
DCFieldget_field_by_name (const std::string &name) const
 Returns a pointer to the DCField that shares the indicated name. More...
 
DCFieldget_inherited_field (int n) const
 Returns the nth field field in the class and all of its ancestors. More...
 
const std::string & get_name () const
 Returns the name of this class. More...
 
int get_num_fields () const
 Returns the number of fields defined directly in this class, ignoring inheritance. More...
 
int get_num_inherited_fields () const
 Returns the total number of field fields defined in this class and all ancestor classes. More...
 
int get_num_parents () const
 Returns the number of base classes this class inherits from. More...
 
int get_number () const
 Returns a unique index number associated with this class. More...
 
DCClassget_parent (int n) const
 Returns the nth parent class this class inherits from. More...
 
bool has_constructor () const
 Returns true if this class has a constructor method, false if it just uses the default constructor. More...
 
bool inherits_from_bogus_class () const
 Returns true if this class, or any class in the inheritance heirarchy for this class, is a "bogus" class–a forward reference to an as-yet-undefined class. More...
 
bool is_bogus_class () const
 Returns true if the class has been flagged as a bogus class. More...
 
bool is_struct () const
 Returns true if the class has been identified with the "struct" keyword in the dc file, false if it was declared with "dclass". More...
 
virtual void output (std::ostream &out) const
 Write a string representation of this instance to <out>. More...
 
virtual void output (std::ostream &out, bool brief) const
 Write a string representation of this instance to <out>. More...
 
void output_instance (std::ostream &out, bool brief, const std::string &prename, const std::string &name, const std::string &postname) const
 Generates a parseable description of the object to the indicated output stream. More...
 
void rebuild_inherited_fields ()
 Recomputes the list of inherited fields for the class. More...
 
void set_number (int number)
 Assigns the unique number to this class. More...
 
void start_generate ()
 Starts the PStats timer going on the "generate" task, that is, marks the beginning of the process of generating a new object, for the purposes of timing this process. More...
 
void stop_generate ()
 Stops the PStats timer on the "generate" task. More...
 
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 DCDeclaration
virtual DCSwitchas_switch ()
 
virtual const DCSwitchas_switch () const
 
void write (std::ostream &out, int indent_level) const
 Write a string representation of this instance to <out>. More...
 

Friends

class DCField
 

Detailed Description

Defines a particular DistributedClass as read from an input .dc file.

Definition at line 44 of file dcClass.h.

Member Function Documentation

◆ add_field()

bool DCClass::add_field ( DCField field)

Adds the newly-allocated field to the class.

The class becomes the owner of the pointer and will delete it when it destructs. Returns true if the field is successfully added, or false if there was a name conflict or some other problem.

Definition at line 1260 of file dcClass.cxx.

◆ add_parent()

void DCClass::add_parent ( DCClass parent)

Adds a new parent to the inheritance hierarchy of the class.

This is normally called only during parsing.

Definition at line 1316 of file dcClass.cxx.

References DCFile::mark_inherited_fields_stale().

◆ clear_inherited_fields()

void DCClass::clear_inherited_fields ( )

Empties the list of inherited fields for the class, so that it may be rebuilt.

This is normally only called by DCFile::rebuild_inherited_fields().

Definition at line 1165 of file dcClass.cxx.

◆ generate_hash()

void DCClass::generate_hash ( HashGenerator hashgen) const

Accumulates the properties of this class into the hash.

Definition at line 1135 of file dcClass.cxx.

References HashGenerator::add_int(), HashGenerator::add_string(), and is_struct().

Referenced by DCClassParameter::generate_hash().

◆ get_constructor()

DCField * DCClass::get_constructor ( ) const

Returns the constructor method for this class if it is defined, or NULL if the class uses the default constructor.

Definition at line 162 of file dcClass.cxx.

◆ get_dc_file()

DCFile * DCClass::get_dc_file ( ) const
inline

Returns the DCFile object that contains the class.

Definition at line 18 of file dcClass.I.

◆ get_field()

DCField * DCClass::get_field ( int  n) const

Returns the nth field in the class.

This is not necessarily the field with index n; this is the nth field defined in the class directly, ignoring inheritance.

Definition at line 181 of file dcClass.cxx.

◆ get_field_by_index()

DCField * DCClass::get_field_by_index ( int  index_number) const

Returns a pointer to the DCField that has the indicated index number.

If the numbered field is not found in the current class, the parent classes will be searched, so the value returned may not actually be a field within this class. Returns NULL if there is no such field defined.

Definition at line 228 of file dcClass.cxx.

◆ get_field_by_name()

DCField * DCClass::get_field_by_name ( const std::string &  name) const

Returns a pointer to the DCField that shares the indicated name.

If the named field is not found in the current class, the parent classes will be searched, so the value returned may not actually be a field within this class. Returns NULL if there is no such field defined.

Definition at line 201 of file dcClass.cxx.

◆ get_inherited_field()

DCField * DCClass::get_inherited_field ( int  n) const

Returns the nth field field in the class and all of its ancestors.

This *used* to be the same thing as get_field_by_index(), back when the fields were numbered sequentially within a class's inheritance hierarchy. Now that fields have a globally unique index number, this is no longer true.

Definition at line 288 of file dcClass.cxx.

◆ get_name()

const std::string & DCClass::get_name ( ) const
inline

Returns the name of this class.

Definition at line 26 of file dcClass.I.

Referenced by DCFile::add_class().

◆ get_num_fields()

int DCClass::get_num_fields ( ) const

Returns the number of fields defined directly in this class, ignoring inheritance.

Definition at line 171 of file dcClass.cxx.

◆ get_num_inherited_fields()

int DCClass::get_num_inherited_fields ( ) const

Returns the total number of field fields defined in this class and all ancestor classes.

Definition at line 255 of file dcClass.cxx.

◆ get_num_parents()

int DCClass::get_num_parents ( ) const

Returns the number of base classes this class inherits from.

Definition at line 135 of file dcClass.cxx.

◆ get_number()

int DCClass::get_number ( ) const
inline

Returns a unique index number associated with this class.

This is defined implicitly when the .dc file(s) are read.

Definition at line 35 of file dcClass.I.

◆ get_parent()

DCClass * DCClass::get_parent ( int  n) const

Returns the nth parent class this class inherits from.

Definition at line 143 of file dcClass.cxx.

◆ has_constructor()

bool DCClass::has_constructor ( ) const

Returns true if this class has a constructor method, false if it just uses the default constructor.

Definition at line 153 of file dcClass.cxx.

◆ inherits_from_bogus_class()

bool DCClass::inherits_from_bogus_class ( ) const

Returns true if this class, or any class in the inheritance heirarchy for this class, is a "bogus" class–a forward reference to an as-yet-undefined class.

Definition at line 319 of file dcClass.cxx.

References is_bogus_class().

◆ is_bogus_class()

bool DCClass::is_bogus_class ( ) const
inline

Returns true if the class has been flagged as a bogus class.

This is set for classes that are generated by the parser as placeholder for missing classes, as when reading a partial file; it should not occur in a normal valid dc file.

Definition at line 55 of file dcClass.I.

Referenced by DCFile::add_class(), inherits_from_bogus_class(), and DCClassParameter::is_valid().

◆ is_struct()

bool DCClass::is_struct ( ) const
inline

Returns true if the class has been identified with the "struct" keyword in the dc file, false if it was declared with "dclass".

Definition at line 44 of file dcClass.I.

Referenced by DCFile::add_class(), and generate_hash().

◆ output() [1/2]

void DCClass::output ( std::ostream &  out) const
virtual

Write a string representation of this instance to <out>.

Reimplemented from DCDeclaration.

Definition at line 338 of file dcClass.cxx.

◆ output() [2/2]

void DCClass::output ( std::ostream &  out,
bool  brief 
) const
virtual

Write a string representation of this instance to <out>.

Implements DCDeclaration.

Definition at line 1020 of file dcClass.cxx.

References output_instance().

◆ output_instance()

void DCClass::output_instance ( std::ostream &  out,
bool  brief,
const std::string &  prename,
const std::string &  name,
const std::string &  postname 
) const

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

Definition at line 1089 of file dcClass.cxx.

Referenced by output(), and DCClassParameter::output_instance().

◆ rebuild_inherited_fields()

void DCClass::rebuild_inherited_fields ( )

Recomputes the list of inherited fields for the class.

Definition at line 1173 of file dcClass.cxx.

◆ set_number()

void DCClass::set_number ( int  number)

Assigns the unique number to this class.

This is normally called only by the DCFile interface as the class is added.

Definition at line 1326 of file dcClass.cxx.

Referenced by DCFile::add_class().

◆ start_generate()

void DCClass::start_generate ( )
inline

Starts the PStats timer going on the "generate" task, that is, marks the beginning of the process of generating a new object, for the purposes of timing this process.

This should balance with a corresponding call to stop_generate().

Definition at line 67 of file dcClass.I.

◆ stop_generate()

void DCClass::stop_generate ( )
inline

Stops the PStats timer on the "generate" task.

This should balance with a preceding call to start_generate().

Definition at line 78 of file dcClass.I.

◆ write()

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

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

Implements DCDeclaration.

Definition at line 1029 of file dcClass.cxx.

References indent().


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