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

Easdif::SDIFEntity Class Reference

class holding all information concerned with a single sdif file. More...

#include <sdifentity.hpp>

Collaboration diagram for Easdif::SDIFEntity:

Collaboration graph
[legend]
List of all members.

Public Types

typedef FRIterator< 0 > iterator
typedef FRIterator< 1 > const_iterator
enum  SelectionPartsE { ,
  eSP_Frame, eSP_Matrix, eSP_Time, eSP_Row,
  eSP_Column, eSP_All
}
 The parts of a selection that can be cleared independently. More...

Public Member Functions

 SDIFEntity ()
 Default constructor.
const_iterator begin () const
 begin iterator
iterator begin ()
 begin iterator
const_iterator end () const
 end iterator
iterator end ()
 SDIFEntity::iterator to end of file.
const SDIFLocationcurrLoc () const
 Get Current Location.
const_iterator current () const
 Get SDIFEntity::const_iterator pointing to current file position.
iterator current ()
 Get SDIFEntity::iterator pointing to current file position.
const DirectoryGetDirectory () const
 get Easdif::Directory of current SDIF File
bool AddFrameType (const std::string &frametype, const std::string &matrix)
 add new frame type or change existing frame type of the entity
bool AddMatrixType (const std::string &matrixtype, const std::string &colnames)
 define a new or redefine an existing matrix type for the entity.
int PrintTypes ()
const std::string & GetTypeString () const
bool SetTypeString (const std::string &TypeString)
bool ChangeSelection (const std::string &selection)
 replace selection for current file
bool MergeSelection (const std::string &selection)
 merge selection to the selection that is currently active
bool ClearSelection (Easdif::SDIFEntity::SelectionPartsE part)
 clear part or all of active selection
bool GetMatrixSelection (SelectionSet< SdifSignature > &out) const
 get the vector of selected matrix signatures that exist for the current file
bool TestMatrixSelection (SdifSignature sig) const
 test whether a given matrix signature is part of the current selection
bool GetFrameSelection (SelectionSet< SdifSignature > &out) const
 get the vector of selected frame signatures that exist for the current file
bool TestFrameSelection (SdifSignature sig) const
 test whether a given frame signature is part of the current selection
bool GetStreamSelection (SelectionSet< unsigned int > &out) const
 get the set of selected streamid's that exist for the current file
bool TestStreamSelection (unsigned int streamid) const
 test whether a given streamid is part of the current selection
bool RestrictFrameSelection (const SelectionSet< SdifSignature > &sigs)
 restrict the frame signature selection
bool ReestablishFrameSelection ()
 reestablish a previous state of frame signature selection
bool RestrictMatrixSelection (const SelectionSet< SdifSignature > &sigs)
 restrict the matrix signature selection
bool ReestablishMatrixSelection ()
 reestablish a previous state of matrix signature selection
bool RestrictStreamSelection (const SelectionSet< unsigned int > &streamid)
 restrict the streamid selection
bool ReestablishStreamSelection ()
 reestablish a previous state of stream signature selection
bool Open (const char *filename, SdifFileModeET Mode)
 open the file of the entity in reading or writing mode
bool OpenRead (const char *filename)
 open a file in reading mode
bool ReOpenRead (const char *filename)
 open a file in reading mode without destroying any information in the internal FrameDirectory
bool OpenWrite (const char *filename)
bool Close ()
 close a file
bool Rewind ()
 rewind a file to first non-ascii frame after the file header
bool isSeekable ()
 examine seekability of current file
SdifFileT * GetFile () const
bool good () const
bool eof () const
bool EnableFrameDir ()
 enable Easdif::Directory for current file
bool IsFrameDir () const
void PrintFrameDir () const
void PrintAllNVTs ()
bool AddNVT (const SDIFNameValueTable &nvt, SdifUInt4 StreamID=0)
int GetNbNVT () const
SDIFNameValueTableGetNVT (unsigned int i)
int ReadNextFrame (SDIFFrame &frame)
 read next frame from file
int ReadNextFrame (SDIFFrame &frame, SdifFloat8 timePos)
 read next frame from file having time equal to or after given time
int ReadNextSelectedFrame (SDIFFrame &frame)
 read next selected frame from file
int ReadNextSelectedFrame (SDIFFrame &frame, SdifFloat8 timePos)
 read next selected frame from file having time equal to or after given time
int WriteFrame (SDIFFrame &frame)

Public Attributes

Directory mFrameDirectory
 the Frame Directory of the current file.

Detailed Description

class holding all information concerned with a single sdif file.

SDIFEntity is composed of different methods that allow the handling of an sdif-file.


Member Enumeration Documentation

enum Easdif::SDIFEntity::SelectionPartsE
 

The parts of a selection that can be cleared independently.

Enumeration values:
eSP_Frame  < Selection on Stream
eSP_Matrix  < Selection on frames
eSP_Time  < Selection on matrix
eSP_Row  < Selection on time
eSP_Column  < Selection on rows
eSP_All  < all selections


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