Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

VirtualFileComposite Class Reference

A composite directory within the VirtualFileSystem: this maps to more than one directory on different mount points. More...

#include <virtualFileComposite.h>

Inheritance diagram for VirtualFileComposite:

List of all members.


Public Member Functions
	VirtualFileComposite (VirtualFileSystem *file_system, const Filename &filename)
void	add_component (VirtualFile *file)
	Adds one more component to the composite directory.
virtual VirtualFileSystem *	get_file_system () const
	Returns the VirtualFileSystem this file is associated with.
virtual Filename	get_filename () const
	Returns the full pathname to this file within the virtual file system.
virtual bool	is_directory () const
	Returns true if this file represents a directory (and scan_directory() may be called), false otherwise.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
virtual bool	is_regular_file () const
	Returns true if this file represents a regular file (and read_file() may be called), false otherwise.
PointerTo< VirtualFileList >	scan_directory () const
	If the file represents a directory (that is, is_directory() returns true), this returns the list of files within the directory at the current time.
void	output (ostream &out) const
void	ls (ostream &out=cout) const
	If the file represents a directory, lists its contents.
void	ls_all (ostream &out=cout) const
	If the file represents a directory, recursively lists its contents and those of all subdirectories.
string	read_file () const
	Returns the entire contents of the file as a string.
bool	read_file (string &result) const
	Fills up the indicated string with the contents of the file, if it is a regular file.
virtual istream *	open_read_file () const
	Opens the file for reading.
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Member Functions
virtual bool	scan_local_directory (VirtualFileList *file_list, const ov_set< string > &mount_points) const
	Fills file_list up with the list of files that are within this directory, excluding those whose basenames are listed in mount_points.
Private Types
typedef pvector< PointerTo< VirtualFile > >	Components
Private Attributes
VirtualFileSystem *	_file_system
Filename	_filename
Components	_components
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

A composite directory within the VirtualFileSystem: this maps to more than one directory on different mount points.

The resulting directory appears to be the union of all the individual simple directories.

Definition at line 42 of file virtualFileComposite.h.

Member Typedef Documentation

typedef pvector< PointerTo< VirtualFile > > VirtualFileComposite::Components [private]

Definition at line 61 of file virtualFileComposite.h.

Constructor & Destructor Documentation

VirtualFileComposite::VirtualFileComposite ( VirtualFileSystem * file_system,

const Filename & filename

) [inline]

Definition at line 32 of file virtualFileComposite.I.
References _components, _file_system, _filename, VirtualFile::get_file_system(), VirtualFile::get_filename(), INLINE, VirtualFile::is_directory(), and nassertv.

Member Function Documentation

void VirtualFileComposite::add_component ( VirtualFile * file ) [inline]

Adds one more component to the composite directory.
The component should be a directory and the file system and filename should match the composite.
Definition at line 51 of file virtualFileComposite.I.

virtual TypeHandle VirtualFileComposite::force_init_type ( void ) [inline, virtual]

Reimplemented from VirtualFile.
Definition at line 68 of file virtualFileComposite.h.

TypeHandle VirtualFileComposite::get_class_type ( void ) [inline, static]

Reimplemented from VirtualFile.
Definition at line 71 of file virtualFileComposite.h.

VirtualFileSystem * VirtualFileComposite::get_file_system ( ) const [virtual]

Returns the VirtualFileSystem this file is associated with.

Implements VirtualFile.
Definition at line 38 of file virtualFileComposite.cxx.
References _filename.

Filename VirtualFileComposite::get_filename ( ) const [virtual]

Returns the full pathname to this file within the virtual file system.

Implements VirtualFile.
Definition at line 53 of file virtualFileComposite.cxx.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle VirtualFileComposite::get_type ( void ) const [inline, virtual]

Reimplemented from VirtualFile.
Definition at line 65 of file virtualFileComposite.h.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void VirtualFileComposite::init_type ( void ) [inline, static]

Reimplemented from VirtualFile.
Definition at line 76 of file virtualFileComposite.h.

bool VirtualFileComposite::is_directory ( ) const [virtual]

Returns true if this file represents a directory (and scan_directory() may be called), false otherwise.

Reimplemented from VirtualFile.
Definition at line 68 of file virtualFileComposite.cxx.
References _components.

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

bool VirtualFile::is_regular_file ( ) const [virtual, inherited]

Returns true if this file represents a regular file (and read_file() may be called), false otherwise.

Reimplemented in VirtualFileSimple.
Definition at line 55 of file virtualFile.cxx.
References VirtualFile::get_file_system(), VirtualFile::get_filename(), PT, VirtualFileSystem::scan_mount_points(), and ov_set< Key, Compare >::sort().

void VirtualFile::ls ( ostream & out = cout ) const [inherited]

If the file represents a directory, lists its contents.

Definition at line 144 of file virtualFile.cxx.
References VirtualFile::get_filename(), VirtualFile::is_directory(), and VirtualFile::r_ls_all().

void VirtualFile::ls_all ( ostream & out = cout ) const [inherited]

If the file represents a directory, recursively lists its contents and those of all subdirectories.

Definition at line 173 of file virtualFile.cxx.
References VirtualFile::get_filename(), NULL, and VirtualFile::open_read_file().

istream * VirtualFile::open_read_file ( ) const [virtual, inherited]

Opens the file for reading.
Returns a newly allocated istream on success (which you should eventually delete when you are done reading). Returns NULL on failure.
Reimplemented in VirtualFileSimple.
Definition at line 196 of file virtualFile.cxx.
Referenced by VirtualFile::ls_all().

void VirtualFile::output ( ostream & out ) const [inherited]

Definition at line 129 of file virtualFile.cxx.

bool VirtualFile::read_file ( string & result ) const [inherited]

Fills up the indicated string with the contents of the file, if it is a regular file.
Returns true on success, false otherwise.
Definition at line 213 of file virtualFile.cxx.
References CPT, VirtualFile::get_filename(), VirtualFile::is_directory(), Filename::make_relative_to(), NULL, VirtualFile::r_ls_all(), root, and VirtualFile::scan_directory().

string VirtualFile::read_file ( ) const [inline, inherited]

Returns the entire contents of the file as a string.

Definition at line 44 of file virtualFile.I.
Referenced by VirtualFile::VirtualFile().

int ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

PointerTo< VirtualFileList > VirtualFile::scan_directory ( ) const [inherited]

If the file represents a directory (that is, is_directory() returns true), this returns the list of files within the directory at the current time.
Returns NULL if the file is not a directory or if the directory cannot be read.
Definition at line 76 of file virtualFile.cxx.
Referenced by VirtualFile::read_file().

bool VirtualFileComposite::scan_local_directory ( VirtualFileList * file_list,

const ov_set< string > & mount_points

) const [protected, virtual]

Fills file_list up with the list of files that are within this directory, excluding those whose basenames are listed in mount_points.
Returns true if successful, false if the file is not a directory or the directory cannot be read.
Reimplemented from VirtualFile.
Definition at line 89 of file virtualFileComposite.cxx.

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref ( ) const [inline, inherited]

Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

Member Data Documentation

Components VirtualFileComposite::_components [private]

Definition at line 62 of file virtualFileComposite.h.
Referenced by is_directory(), and VirtualFileComposite().

VirtualFileSystem* VirtualFileComposite::_file_system [private]

Definition at line 59 of file virtualFileComposite.h.
Referenced by VirtualFileComposite().

Filename VirtualFileComposite::_filename [private]

Definition at line 60 of file virtualFileComposite.h.
Referenced by get_file_system(), and VirtualFileComposite().

TypeHandle VirtualFileComposite::_type_handle [static, private]

Reimplemented from VirtualFile.
Definition at line 24 of file virtualFileComposite.cxx.

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

panda/src/express/virtualFileComposite.h
panda/src/express/virtualFileComposite.cxx
panda/src/express/virtualFileComposite.I

Generated on Fri May 2 00:56:04 2003 for Panda by

1.3

VirtualFileComposite Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation