Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

TxqMovieConfigSet Class Reference

TxqMovieConfigSet is a class to access the movie configuration TxAttributeSet. More...

#include <TxqMovieConfigSet.h>

Inheritance diagram for TxqMovieConfigSet::

TxAttributeSet List of all members.

Public Methods

 TxqMovieConfigSet ()
 Construct a TxqMovieConfigSet with a default constructor. More...

 TxqMovieConfigSet (QString s)
 Construct a TxqMovieConfigSet with a default name. More...

 TxqMovieConfigSet (const TxqMovieConfigSet &)
 Copy constructor makes an exact duplicate. More...

virtual ~TxqMovieConfigSet ()
 Destructor. More...

TxqMovieConfigSet& operator= (const TxqMovieConfigSet &)
 Assignment is set identically. More...

void setImageFrameCount (int imageFrameCount)
 Set the imageFrameCount variable. More...

int getImageFrameCount ()
 Get the imageFrameCount variable. More...

void setStatusLabel (QString statusLabel, double statusLabelValue=0.0)
 Set the status label variable. More...

QString getStatusLabel ()
 Get the status label variable. More...

void setStatusLabelValue (double value)
 Set the status label update variable. More...

double getStatusLabelValue ()
 Get the status label update variable. More...

TxAttributeSet getFrameSet (int index)
 Get the attribute set at the specified index. More...

bool hasFrameOption (const QString &optionName, const int index)
 Return whether has an option of this name at this index number. More...

void setFrameOption (const QString &optionName, int value, int index)
 Set the value of the option of this name. More...

int getFrameOption (const QString &optionName, const int index) throw (TxDebugExcept)
 Get the value of the option of this name. More...

bool hasFrameString (const QString &stringName, const int index)
 Determine whether has a QString of a given name at this frame index number. More...

void setFrameString (const QString &stringName, const QString &value, int index)
 Set the value of a QString at the given frame index. More...

QString getFrameString (const QString &stringName, const int index) throw (TxDebugExcept)
 Get a QString of a given name at the given frame index number. More...

void write (const QString &fileName) const
 Write out the attributes text representation to a file. More...

void write (ostream &ostr,bool flag=false) const
 Declare the base class write method. More...

void read (const QString &fileName)
 read from a filename. More...

virtual TXSTD::string read (istream &is)
 Declare the base class read method. More...


Protected Methods

void initialize ()
 initialize class data members. More...

bool checkIndex (const int index)
 Checks the index for the frame. More...


Protected Attributes

int imageFrameCount
 The image frame count. More...

QString statusLabel
 The statusLabel value. More...

double statusLabelValue
 The status label update value This value will appear next to the statusLabel and can be updated at frame intervals. More...

TXSTD::vector<TxAttributeSet> frameSets
 The vector of attribute sets for the frames. More...

Detailed Description

TxqMovieConfigSet is a class to access the movie configuration TxAttributeSet.

Copyright 2001 by Tech-X Corporation

Author:
Kelly G. Luetkemeyer

Version:
Id:
TxqMovieConfigSet.h,v 1.5 2001/10/12 20:12:57 kgl Exp

Definition at line 35 of file TxqMovieConfigSet.h.

Constructor & Destructor Documentation

TxqMovieConfigSet::TxqMovieConfigSet ( )
 

Construct a TxqMovieConfigSet with a default constructor.

TxqMovieConfigSet::TxqMovieConfigSet ( QString s )
 

Construct a TxqMovieConfigSet with a default name.

Parameters:
s   the name for the config set.

TxqMovieConfigSet::TxqMovieConfigSet ( const TxqMovieConfigSet & )
 

Copy constructor makes an exact duplicate.

TxqMovieConfigSet::~TxqMovieConfigSet ( ) [virtual]
 

Destructor.

Member Function Documentation

bool TxqMovieConfigSet::checkIndex ( const int index ) [protected]
 

Checks the index for the frame.

If the index is greater than the frame count, a new attribute set is created. returns false if the index is one plus the size of the frame set vector

Parameters:
index   the index number to check for validity.

int TxqMovieConfigSet::getFrameOption ( const QString & optionName,
const int index ) throw (TxDebugExcept)
 

Get the value of the option of this name.

Parameters:
optionName   the name of the option under consideration
index   the index number of the frame

Returns:
the value of the option of this name

TxAttributeSet TxqMovieConfigSet::getFrameSet ( int index )
 

Get the attribute set at the specified index.

Parameters:
index   the index to get the attribute set
Returns:
the frame TxAttributeSet

QString TxqMovieConfigSet::getFrameString ( const QString & stringName,
const int index ) throw (TxDebugExcept)
 

Get a QString of a given name at the given frame index number.

Parameters:
stringName   the name of the QString
index   the index number of the frame

Returns:
the value of the QString

int TxqMovieConfigSet::getImageFrameCount ( ) [inline]
 

Get the imageFrameCount variable.

Returns:
the number of image frames in this config set.

Definition at line 77 of file TxqMovieConfigSet.h.

QString TxqMovieConfigSet::getStatusLabel ( ) [inline]
 

Get the status label variable.

Returns:
the status label QString

Definition at line 90 of file TxqMovieConfigSet.h.

double TxqMovieConfigSet::getStatusLabelValue ( ) [inline]
 

Get the status label update variable.

Returns:
the statusLabelValue which will be updated at each frame count

Definition at line 103 of file TxqMovieConfigSet.h.

bool TxqMovieConfigSet::hasFrameOption ( const QString & optionName,
const int index )
 

Return whether has an option of this name at this index number.

Parameters:
optionName   the name to check.
index   the index number of the frame

Returns:
whether has this option

bool TxqMovieConfigSet::hasFrameString ( const QString & stringName,
const int index )
 

Determine whether has a QString of a given name at this frame index number.

Parameters:
stringName   the name under consideration
the   index number of the frame

Returns:
whether has a QString of this name

void TxqMovieConfigSet::initialize ( ) [protected]
 

initialize class data members.

TxqMovieConfigSet & TxqMovieConfigSet::operator= ( const TxqMovieConfigSet & )
 

Assignment is set identically.

TXSTD::string TxqMovieConfigSet::read ( istream & is ) [inline, virtual]
 

Declare the base class read method.

Parameters:
is   the input file stream to read

Definition at line 209 of file TxqMovieConfigSet.h.

void TxqMovieConfigSet::read ( const QString & fileName )
 

read from a filename.

Parameters:
fileName   the fileName to read

void TxqMovieConfigSet::setFrameOption ( const QString & optionName,
int value,
int index )
 

Set the value of the option of this name.

Parameters:
optionName   the name of this option
value   the new value of this option
index   the index value of this frame

void TxqMovieConfigSet::setFrameString ( const QString & stringName,
const QString & value,
int index )
 

Set the value of a QString at the given frame index.

Parameters:
stringName   the name of the QString
value   the new value of the QString
index   the index number of the frame

void TxqMovieConfigSet::setImageFrameCount ( int imageFrameCount )
 

Set the imageFrameCount variable.

Parameters:
imageFrameCount   the number of image frames in this config set.

void TxqMovieConfigSet::setStatusLabel ( QString statusLabel,
double statusLabelValue = 0.0 )
 

Set the status label variable.

Parameters:
statusLabel   the status label QString
statusLabelValue   the statusLabel variable value

void TxqMovieConfigSet::setStatusLabelValue ( double value )
 

Set the status label update variable.

This variable will be added to the statusLabelValue

Parameters:
value   the statusLabelValue will be updated at each frame count

void TxqMovieConfigSet::write ( ostream & ostr,
bool flag = false ) const [inline]
 

Declare the base class write method.

Parameters:
ostr   the stream to write to
flag   the dump flag

Definition at line 195 of file TxqMovieConfigSet.h.

void TxqMovieConfigSet::write ( const QString & fileName ) const
 

Write out the attributes text representation to a file.

Parameters:
fileName   the fileName to write

Member Data Documentation

TXSTD::vector< TxAttributeSet > TxqMovieConfigSet::frameSets [protected]
 

The vector of attribute sets for the frames.

Definition at line 249 of file TxqMovieConfigSet.h.

int TxqMovieConfigSet::imageFrameCount [protected]
 

The image frame count.

This is the number of image frames that will be opened.

Definition at line 231 of file TxqMovieConfigSet.h.

QString TxqMovieConfigSet::statusLabel [protected]
 

The statusLabel value.

This is the label that will appear in the statusBar.

Definition at line 237 of file TxqMovieConfigSet.h.

double TxqMovieConfigSet::statusLabelValue [protected]
 

The status label update value This value will appear next to the statusLabel and can be updated at frame intervals.

Definition at line 244 of file TxqMovieConfigSet.h.

The documentation for this class was generated from the following file: Copyright Tech-X Corporation, all rights reserved.