This encapsulates a SoftImage versioned filename, of the form base.v-v.ext: it consists of a directory name, a base, a major and minor version number, and an optional extension. More...

#include "softFilename.h"

Public Member Functions
	SoftFilename (const string &dirname, const string &filename)
	SoftFilename (const SoftFilename &copy)
string	get_1_0_filename () const
	Returns what the filename would be if it were version 1-0.
const string &	get_base () const
	Returns the base part of the filename.
const string &	get_dirname () const
	Returns the name of the directory this file was found in.
const string &	get_extension () const
	Returns the extension part of the filename.
const string &	get_filename () const
	Returns the actual filename as found in the directory.
bool	get_in_cvs () const
	Returns true if this file is known to be entered in the CVS database, false if it is not.
int	get_major () const
	Returns the major version number.
int	get_minor () const
	Returns the minor version number.
string	get_non_extension () const
	Returns the filename part, without the extension.
int	get_use_count () const
	Returns the number of scene files that referenced this filename.
bool	get_wants_cvs () const
	Returns true if this file should be entered into the CVS database, false otherwise.
bool	has_version () const
	Returns true if the filename had a version number, false otherwise.
void	increment_use_count ()
	Indicates that this filename is referenced by one more scene file.
bool	is_1_0 () const
	Returns true if this is a version 1_0 filename, false otherwise.
bool	is_same_file (const SoftFilename &other) const
	Returns true if this file has the same base and extension as the other, disregarding the version number; false otherwise.
void	make_1_0 ()
	Makes this a 1_0 filename.
bool	operator< (const SoftFilename &other) const
	Puts filenames in order such that the files with the same base are sorted together, ignoring extension; and within files with the same base, files are sorted in decreasing version number order so that the most recent version appears first.
void	operator= (const SoftFilename &copy)
void	set_in_cvs (bool in_cvs)
	Sets the flag that indicates whether this file is known to be entered into the CVS database.
void	set_wants_cvs (bool wants_cvs)
	Sets the flag that indicates whether this file should be entered into the CVS database.

Detailed Description

This encapsulates a SoftImage versioned filename, of the form base.v-v.ext: it consists of a directory name, a base, a major and minor version number, and an optional extension.

It also keeps track of whether the named file has been added to CVS, and how many scene files it is referenced by,

Definition at line 31 of file softFilename.h.

Member Function Documentation

string SoftFilename::get_1_0_filename ( ) const

Returns what the filename would be if it were version 1-0.

Definition at line 146 of file softFilename.cxx.

Referenced by make_1_0().

const string & SoftFilename::get_base ( ) const

Returns the base part of the filename.

This is everything before the version number.

Definition at line 158 of file softFilename.cxx.

const string & SoftFilename::get_dirname ( ) const

Returns the name of the directory this file was found in.

Definition at line 113 of file softFilename.cxx.

const string & SoftFilename::get_extension ( ) const

Returns the extension part of the filename.

This is everything after the version number.

Definition at line 192 of file softFilename.cxx.

const string & SoftFilename::get_filename ( ) const

Returns the actual filename as found in the directory.

Definition at line 124 of file softFilename.cxx.

bool SoftFilename::get_in_cvs ( ) const

Returns true if this file is known to be entered in the CVS database, false if it is not.

Definition at line 297 of file softFilename.cxx.

int SoftFilename::get_major ( ) const

Returns the major version number.

Definition at line 169 of file softFilename.cxx.

int SoftFilename::get_minor ( ) const

Returns the minor version number.

Definition at line 180 of file softFilename.cxx.

string SoftFilename::get_non_extension ( ) const

Returns the filename part, without the extension.

Definition at line 203 of file softFilename.cxx.

int SoftFilename::get_use_count ( ) const

Returns the number of scene files that referenced this filename.

Definition at line 341 of file softFilename.cxx.

bool SoftFilename::get_wants_cvs ( ) const

Returns true if this file should be entered into the CVS database, false otherwise.

Definition at line 319 of file softFilename.cxx.

bool SoftFilename::has_version ( ) const

Returns true if the filename had a version number, false otherwise.

Definition at line 135 of file softFilename.cxx.

void SoftFilename::increment_use_count ( )

Indicates that this filename is referenced by one more scene file.

Definition at line 330 of file softFilename.cxx.

bool SoftFilename::is_1_0 ( ) const

Returns true if this is a version 1_0 filename, false otherwise.

Definition at line 216 of file softFilename.cxx.

bool SoftFilename::is_same_file ( const SoftFilename & other ) const

Returns true if this file has the same base and extension as the other, disregarding the version number; false otherwise.

Definition at line 242 of file softFilename.cxx.

void SoftFilename::make_1_0 ( )

Makes this a 1_0 filename.

Definition at line 227 of file softFilename.cxx.

References get_1_0_filename().

bool SoftFilename::operator< ( const SoftFilename & other ) const

Puts filenames in order such that the files with the same base are sorted together, ignoring extension; and within files with the same base, files are sorted in decreasing version number order so that the most recent version appears first.

Definition at line 256 of file softFilename.cxx.

void SoftFilename::set_in_cvs ( bool in_cvs )

Sets the flag that indicates whether this file is known to be entered into the CVS database.

Definition at line 286 of file softFilename.cxx.

void SoftFilename::set_wants_cvs ( bool wants_cvs )

Sets the flag that indicates whether this file should be entered into the CVS database.

Definition at line 308 of file softFilename.cxx.

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

pandatool/src/softprogs/softFilename.h
pandatool/src/softprogs/softFilename.cxx

Public Member Functions

Detailed Description

Member Function Documentation