TSLS63MediaFile Class Reference

Detailed Description

This class represents the contents of the MEDIA.TXT file from an S63 Large Media dataset.

Public Member Functions
const TSLS63MediaRecord *	at (int index) const
const char *	dataServerID () const
TSLTimeType	dateOfIssue () const
void	destroy ()
const char *	machineReadableMediaID () const
const char *	mediaID () const
const char *	mediaLabel () const
TSLS63CDTypeEnum	mediaType () const
const char *	regionalInformation () const
int	size () const
const char *	weekOfIssue () const
const TSLS63MediaRecord *	operator[] (int index) const

Static Public Member Functions
static TSLS63MediaFile *	create (const char *filename)

Member Function Documentation

at()

const TSLS63MediaRecord * TSLS63MediaFile::at

(

int

index

)

const

Returns the media record at the given index in the container. If the index is invalid then this method will return NULL.

Parameters

index

The index of the media record to return.

create()

static TSLS63MediaFile * TSLS63MediaFile::create ( const char * filename )

static

Loads and extracts all media records contained within a single MEDIA.TXT file from an S63 large media dataset.

Parameters

filename

Full path including filename to the MEDIA.TXT file to load.

Returns

a collection of loaded records if the file was parsed successfully, or NULL if an error was encountered.

dataServerID()

const char * TSLS63MediaFile::dataServerID

(

)

const

Returns the two-character data server ID of the data server that issued the exchange set. The returned string will be NULL terminated.

dateOfIssue()

TSLTimeType TSLS63MediaFile::dateOfIssue

(

)

const

Returns the date that the media was issued in the form of number of seconds elapsed since 00:00:00 January 1 1970 UTC.

destroy()

void TSLS63MediaFile::destroy

(

)

This should be called rather than deleting the collection, since the calls are redirected internally to MapLink.

machineReadableMediaID()

const char * TSLS63MediaFile::machineReadableMediaID

(

)

const

Returns the machine-readable media name for the dataset contained within the MEDIA.TXT file.

This field is optional and so may not be present. In this situation this method will return NULL.

mediaID()

const char * TSLS63MediaFile::mediaID

(

)

const

Returns the media ID of the dataset. This is in the form of M followed by a number between 1 and 99, e.g.

M1 M2 M11

mediaLabel()

const char * TSLS63MediaFile::mediaLabel

(

)

const

Returns the label ID of the dataset. This is in the form M[01-99]X[01-99].

mediaType()

TSLS63CDTypeEnum TSLS63MediaFile::mediaType

(

)

const

Returns the type of dataset that the MEDIA.TXT file represents. For more information see the documentation for the TSLS63CDTypeEnum enumeration.

operator[]()

const TSLS63MediaRecord * TSLS63MediaFile::operator[]

(

int

index

)

const

Returns the media record at the given index in the container. If the index is invalid then this method will return NULL.

Parameters

index

The index of the media record to return.

regionalInformation()

const char * TSLS63MediaFile::regionalInformation

(

)

const

Returns any regional information contained within the MEDIA.TXT file.

This field is optional and so may not be present. In this situation this method will return NULL.

size()

int TSLS63MediaFile::size

(

)

const

Returns the number of records that were loaded from the MEDIA.TXT file.

weekOfIssue()

const char * TSLS63MediaFile::weekOfIssue

(

)

const

Returns the week of issue of the dataset described by the MEDIA.TXT file.

This is in the form WKNN_YY, where:

WK is a fixed character prefix. NN is the week number on which the dataset was issued. YY is the year in which the dataset was issued.