WXP C++ Library Version 6.74.9
Loading...
Searching...
No Matches
Public Member Functions | List of all members
WXP::NameConvFile Class Reference

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

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

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::NameConvFile ( )

Constructor. Initializes the values.

References init().

Member Function Documentation

◆ getDate() [1/2]

Date NameConvFile::getDate ( )

Gets the date of the corresponding filenames

Returns
Date of filenames

◆ getDate() [2/2]

int NameConvFile::getDate ( Date rdate)

Gets the date of the corresponding filenames

Return values
rdateDate of filenames

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

◆ getFilename()

const char * NameConvFile::getFilename ( )

◆ getHdrFilename()

const char * NameConvFile::getHdrFilename ( )

◆ getOffset()

int NameConvFile::getOffset ( )

Gets the time offset between filenames

Returns
The time offset in seconds

◆ getParam()

const char * NameConvFile::getParam ( )

Gets the name convention parameters

Returns
The additional name convention parameters

◆ getType()

const char * NameConvFile::getType ( )

Gets the name convention type

Returns
The name convention type

◆ init()

int NameConvFile::init ( )

Initializes the class values

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

◆ print()

int NameConvFile::print ( )

Prints the values in the class

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

◆ setDate()

int NameConvFile::setDate ( Date rdate)

Sets the date the corresponds to the filenames

Parameters
rdateDate of filenames

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

◆ setFilename() [1/2]

int NameConvFile::setFilename ( const char *  str)

Sets the filename

Parameters
strThe filename to set

References WXP::StrLib::copy().

◆ setFilename() [2/2]

int NameConvFile::setFilename ( String str)

Sets the filename

Parameters
strString class used to set filename

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

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

◆ setHdrFilename() [1/2]

int NameConvFile::setHdrFilename ( const char *  str)

Sets the header filename

Parameters
strThe header filename to set

References WXP::StrLib::copy().

◆ setHdrFilename() [2/2]

int NameConvFile::setHdrFilename ( String str)

Sets the header filename

Parameters
strString class used the set filename

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

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

◆ setOffset()

int NameConvFile::setOffset ( int  val)

Sets the time offset between filenames

Parameters
valThe time offset in seconds

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

◆ setParam()

int NameConvFile::setParam ( const char *  str)

Sets the name convention parameters

Parameters
strString containing additional parameters

References WXP::StrLib::copy().

◆ setType()

int NameConvFile::setType ( const char *  rtype)

Sets the name convention type (tag)

Parameters
rtypeThe 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: