Syndicate::Data::File Class Reference

#include <Syndicate/Data/File.h>

Inheritance diagram for Syndicate::Data::File:

Syndicate::Data::Font Syndicate::Data::Game Syndicate::Data::MapColumn Syndicate::Data::MapData Syndicate::Data::MapTile Syndicate::Data::Mission Syndicate::Data::Palette Syndicate::Data::Raw Syndicate::Data::Req Syndicate::Data::SpriteAnim Syndicate::Data::SpriteData Syndicate::Data::SpriteElement Syndicate::Data::SpriteFrame Syndicate::Data::SpriteTab List of all members.

Public Member Functions

 File (uint8_t **data)
virtual ~File (void)
virtual void info (void)
bool load (char const *filename)
unsigned getLength (void)

Protected Attributes

unsigned _data_length

Private Attributes

char _filename [PATH_MAX]
uint8_t ** _data

Constructor & Destructor Documentation

Syndicate::Data::File::File ( uint8_t **  data  ) 

The constructor initialise the pointer to the memory where the data will be located.

[in] data a pointer to the pointer which will hold the data.

virtual Syndicate::Data::File::~File ( void   )  [virtual]

Member Function Documentation

virtual void Syndicate::Data::File::info ( void   )  [virtual]

In debug mode it display the informations.

bool Syndicate::Data::File::load ( char const *  filename  ) 

This method load the content (unpacked) of the file at the adress pointed by _data.

[in] filename the name of the file.
Return values:
true if success.
false if fails. If previous file is loaded, the data keep unaffected.

unsigned Syndicate::Data::File::getLength ( void   )  [inline]

Member Data Documentation

char Syndicate::Data::File::_filename[PATH_MAX] [private]

uint8_t** Syndicate::Data::File::_data [private]

Reimplemented in Syndicate::Data::Font, Syndicate::Data::Game, Syndicate::Data::MapData, Syndicate::Data::MapTile, Syndicate::Data::Raw, and Syndicate::Data::SpriteData.

unsigned Syndicate::Data::File::_data_length [protected]

The documentation for this class was generated from the following file:
Generated on Sun Sep 30 13:08:36 2007 for libSyndicate by  doxygen 1.5.2