WXP::NameConvFile Class Reference

This class stores values returned by the NameConv class. More...

#include "../include/NameConvFile.h"

List of all members.

Public Member Functions
	NameConvFile ()
int	init ()
int	setType (const char *rtype)
const char *	getType ()
int	setFilename (String &str)
int	setFilename (const char *str)
const char *	getFilename ()
int	setHdrFilename (String &str)
int	setHdrFilename (const char *str)
const char *	getHdrFilename ()
int	setDate (Date &rdate)
int	getDate (Date &rdate)
Date	getDate ()
int	setParam (const char *str)
const char *	getParam ()
int	setOffset (int val)
int	getOffset ()
int	print ()

---

Detailed Description

This class stores values returned by the NameConv class.

Author:

Dan Vietor

---

Constructor & Destructor Documentation

NameConvFile::NameConvFile

(

)

Constructor. Initializes the values.

References init().

---

Member Function Documentation

Date NameConvFile::getDate

(

)

Gets the date of the corresponding filenames

Returns:

Date of filenames

int NameConvFile::getDate

(

Date &

rdate

)

Gets the date of the corresponding filenames

Return values:

rdate

Date of filenames

Referenced by WXP::Filename::checkFile(), WXP::Filename::set(), WXP::Filename::setDate(), WXP::Filename::setFile(), and WXP::Filename::setFilePrompt().

const char * NameConvFile::getFilename

(

)

Returns the saved filename

Returns:

The filename

Referenced by WXP::Filename::checkFile(), WXP::Filename::set(), WXP::Filename::setDate(), WXP::Filename::setFile(), and WXP::Filename::setFilePrompt().

const char * NameConvFile::getHdrFilename

(

)

Gets the saved header filename

Returns:

The header filename

Referenced by WXP::Filename::checkFile(), WXP::Filename::set(), WXP::Filename::setDate(), WXP::Filename::setFile(), and WXP::Filename::setFilePrompt().

int NameConvFile::getOffset

(

)

Gets the time offset between filenames

Returns:

The time offset in seconds

const char * NameConvFile::getParam

(

)

Gets the name convention parameters

Returns:

The additional name convention parameters

const char * NameConvFile::getType

(

)

Gets the name convention type

Returns:

The name convention type

int NameConvFile::init

(

)

Initializes the class values

Referenced by NameConvFile(), and WXP::NameConv::setLatest().

int NameConvFile::print

(

)

Prints the values in the class

References WXP::Date::print(), and WXP::StrLib::valid().

int NameConvFile::setDate

(

Date &

rdate

)

Sets the date the corresponds to the filenames

Parameters:

rdate

Date of filenames

Referenced by WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

int NameConvFile::setFilename

(

const char *

str

)

Sets the filename

Parameters:

str

The filename to set

References WXP::StrLib::copy().

int NameConvFile::setFilename

(

String &

str

)

Sets the filename

Parameters:

str

String class used to set filename

References WXP::StrLib::copy(), and WXP::String::get().

Referenced by WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

int NameConvFile::setHdrFilename

(

const char *

str

)

Sets the header filename

Parameters:

str

The header filename to set

References WXP::StrLib::copy().

int NameConvFile::setHdrFilename

(

String &

str

)

Sets the header filename

Parameters:

str

String class used the set filename

References WXP::StrLib::copy(), and WXP::String::get().

Referenced by WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

int NameConvFile::setOffset

(

int

val

)

Sets the time offset between filenames

Parameters:

val

The time offset in seconds

Referenced by WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

int NameConvFile::setParam

(

const char *

str

)

Sets the name convention parameters

Parameters:

str

String containing additional parameters

References WXP::StrLib::copy().

int NameConvFile::setType

(

const char *

rtype

)

Sets the name convention type (tag)

Parameters:

rtype

The name convention type

References WXP::StrLib::copy().

Referenced by WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

---

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

• NameConvFile.h
• NameConvFile.cc