Tms::TmsCycleParams Class Reference

Internal CycleParameter management class. More...

#include <TmsLib.h>

List of all members.

Public Member Functions

 TmsCycleParams (BString baseDir=".")
BError getCycleTypes (BList< BString > &typeList)
 Get the list of CycleParameter types in the directory.
BError getFileNames (BList< BString > &fileList)
 Get a list of all of the CycleParameter file names.
BError getCycleParams (BString fileName, Tms::CycleParam &param)
 Get the CycleParameter from the given file name.
BError setCycleParams (Tms::CycleParam param)
 Set the CycleParameters. Writes to the appropriate file name.
BError deleteCycleParams (BString cycleType, UInt32 puChannel)
 Deletes a CycleParameter definition file.
BError readCycleParams (BString fileName, Tms::CycleParam &param)
 Reads a set of CycleParameters from a file.
BError writeCycleParams (BString fileName, Tms::CycleParam param)
 Writes a set of CycleParameters to a file.
BError writeToString (Tms::CycleParam param, BString &str)
 Converts the Cycle parameters to a string for display.

Private Attributes

BString obaseDir


Detailed Description

Internal CycleParameter management class.


Constructor & Destructor Documentation

Tms::TmsCycleParams::TmsCycleParams ( BString  baseDir = "."  ) 


Member Function Documentation

BError Tms::TmsCycleParams::getCycleTypes ( BList< BString > &  typeList  ) 

Get the list of CycleParameter types in the directory.

BError Tms::TmsCycleParams::getFileNames ( BList< BString > &  fileList  ) 

Get a list of all of the CycleParameter file names.

BError Tms::TmsCycleParams::getCycleParams ( BString  fileName,
Tms::CycleParam param 
)

Get the CycleParameter from the given file name.

BError Tms::TmsCycleParams::setCycleParams ( Tms::CycleParam  param  ) 

Set the CycleParameters. Writes to the appropriate file name.

BError Tms::TmsCycleParams::deleteCycleParams ( BString  cycleType,
UInt32  puChannel 
)

Deletes a CycleParameter definition file.

BError Tms::TmsCycleParams::readCycleParams ( BString  fileName,
Tms::CycleParam param 
)

Reads a set of CycleParameters from a file.

BError Tms::TmsCycleParams::writeCycleParams ( BString  fileName,
Tms::CycleParam  param 
)

Writes a set of CycleParameters to a file.

BError Tms::TmsCycleParams::writeToString ( Tms::CycleParam  param,
BString str 
)

Converts the Cycle parameters to a string for display.


Member Data Documentation

BString Tms::TmsCycleParams::obaseDir [private]


The documentation for this class was generated from the following files:
Generated on Tue Jun 19 11:18:32 2007 for LibTmsApi by  doxygen 1.5.1