Main Page | Class List | File List | Class Members

CVersionRecord Class Reference

#include <version.h>

List of all members.

Public Member Functions

 CVersionRecord (char *fileName, char *date, char *versionString)
virtual ~CVersionRecord ()
std::string GetFile ()
std::string GetVersion ()
std::string GetDate ()


Detailed Description

This is a version holding record, which stores the version string of a given source file.

When this versioning system is used throughout a program each source file will have an associated CVersionRecord object, this information can be queried or displayed, etc, at runtime.

When the program wishes to query its own version information it can use the CVersion class to return a list of all the individual CVersionRecord objects - then display, or use that list.

See also:
CVersion
Author:
Steve Kemp http://www.steve.org.uk/
Version:
Revision
1.2


Constructor & Destructor Documentation

CVersionRecord::CVersionRecord char *  fileName,
char *  date,
char *  versionString
 

Create a new version information record.

Parameters:
fileName The file that this record covers, use _ _ FILE _ _
date The current date, use _ _ DATE _ _
versionString A version string for this file.

CVersionRecord::~CVersionRecord  )  [virtual]
 

Destructor.


Member Function Documentation

std::string CVersionRecord::GetDate  ) 
 

Get the compilation date and time of this file.

Returns:
The date and time at which the file was last recompiled.

std::string CVersionRecord::GetFile  ) 
 

Get the filename that was stored in this record.

Returns:
The filename that was stored in this record.

std::string CVersionRecord::GetVersion  ) 
 

Get the version string that was stored in this record.

Returns:
The version string that was stored in this record.


The documentation for this class was generated from the following files:
Generated on Tue Oct 25 23:04:38 2005 for fortress by  doxygen 1.4.2