Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members

Easdif::SDIFFrame Class Reference

class which can be associated with a frame More...

#include <sdifframe.hpp>

List of all members.

Public Types

typedef std::vector< SDIFMatrix
>::iterator 
iterator

Public Member Functions

 SDIFFrame ()
 default constructor
int Read (SdifFileT *file, bool &eof)
int ReadData (SdifFileT *file, const std::set< SdifSignature > *hlsig=0)
 Read Frame Data read the frame data (used by Read).
int ReadHeader (SdifFileT *file)
int Write (SdifFileT *file)
int WriteHeader (SdifFileT *file)
int Read (SDIFEntity &entity)
 read a frame
int AddMatrix (const SDIFMatrix &aMatrix)
int AddMatrixSelected (SdifFileT *file, const SDIFMatrix &aMatrix)
void Print ()
 see the content of a frame
void PrintHeader ()
 see the frame header
void ClearData ()
 reinitialize the frame: remove all matrices and set all headers to initial default values
void clear ()
 reinitialize the frame: remove all matrices and set all headers to initial default values
void Resize (int _size)
 resize the vector to hold _size SDIFMatrices
void resize (int _size)
 resize the vector to hold _size SDIFMatrices
SdifSignature GetMatrixSelection (SdifFileT *file) const
bool MatrixExists (const SdifSignature &sig) const
 check if a matrix type exist in the frame with a SdifSignature
bool MatrixExists (const std::string &signature) const
 check if a matrix type exist in the frame with a string signature
SDIFMatrixGetMatrix (unsigned int index) throw (Easdif::SDIFMatrixNotAvailable)
 get the matrix number i which is stored in the vector of matrix
SDIFMatrixGetMatrixWithSig (const SdifSignature sig) throw (SDIFMatrixNotAvailable)
SDIFMatrixGetMatrix (const std::string &signature) throw (SDIFMatrixNotAvailable)
iterator begin ()
iterator end ()
SdifUInt4 GetNbMatrix () const
 get the number of matrix in the frame
SdifUInt4 size () const
 get the number of matrix in the frame
SdifSignature GetSignature () const
 get the signature of the frame
void GetSignature (std::string &sig) const
 get the signature of the frame
SdifUInt4 GetStreamID () const
 get the streamID of the frame
SdifFloat8 GetTime () const
 get the time of the frame
SdifUInt4 GetSize () const
 get the size of the frame
void SetHeader (SdifSignature sig, SdifUInt4 streamID, float time)
 Set the frame header.
void SetHeader (const std::string &sig, SdifUInt4 streamID, float time)
 Set the frame header.
void SetSignature (SdifSignature sig)
 Set one element of the frame header : the signature.
void SetSignature (const std::string &signature)
 Set one element of the frame header : the signature with a string.
void SetStreamID (SdifUInt4 streamID)
 Set one element of the frame header : the streamID.
void SetTime (float time)
 Set one element of the frame header : the time.
bool operator< (SDIFFrame compareTo) const
 comparator function on the time


Detailed Description

class which can be associated with a frame

SDIFFrame is composed of different methods which permits to manipulate a frame. All the methods with a SdifFileT* parameter are surcharged with SDIFEntity parameter.


The documentation for this class was generated from the following files:
Generated on Tue Jan 3 15:01:00 2006 for Easdif by  doxygen 1.3.9.1