Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CXSIFilter Class Reference

Base class for filters. More...

#include <CXSIFilter.h>

Inheritance diagram for CXSIFilter::

CASCIIFilter CBINFilter CBufferFilter CLegacyFilter List of all members.

Public Methods


Detailed Description

Base class for filters.

This base class defines the basis for all filters in the system. A filter will be used both for reading and writing to/from a file. Filters can be chained so we can create constructs like, BUFFERING | ASCII or COMPRESS for example.


Constructor & Destructor Documentation

CXSIFilter::CXSIFilter  
 

Constructor

CXSIFilter::~CXSIFilter   [virtual]
 

Destructor


Member Function Documentation

int CXSIFilter::Close   [virtual]
 

Closes the file when finished

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

int CXSIFilter::Eof   [virtual]
 

Tests whether we have reached the end of file

Returns:
int flag for end of file (1 - end of file, 0 - not end of file)

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

CSIBCString CXSIFilter::GetHeader  
 

returns the current header

Returns:
SIBCString Header

CSIBCString & CXSIFilter::GetID  
 

returns the current ID

Returns:
SIBCString ID

CSIBCString CXSIFilter::GetName  
 

Returns the name of the file used

Returns:
CSIBCString Name of the file.

CXSIFilter* CXSIFilter::GetSubFilter   [inline]
 

Returns the current subfilter

Returns:
CXSIFilter* subfilter

int CXSIFilter::Open CSIBCString    in_szFilename,
_SI_FILE_MODE    in_Mode
[virtual]
 

Opens the file for either reading or writing

Parameters:
in_szFilename  Filename
in_Mode  mode

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

int CXSIFilter::Read SI_Char *    out_pBuffer,
SI_Long    in_lSize
[virtual]
 

Reads a number of bytes into the buffer passed in.

Parameters:
out_pBuffer  output buffer
in_lSize  number of bytes to read
Returns:
int number of bytes read.

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

void CXSIFilter::SetHeader CSIBCString    in_szHeader
 

Sets the header to be used for the file ("xsi 0360txt") for example

Parameters:
in_szHeader  header

void CXSIFilter::SetID const CSIBCString   in_szID
 

Sets the ID for the filter. This ID will appear inside the dotXSI header

Parameters:
in_szID  String ID ("txt" or "bin")

void CXSIFilter::SetName const CSIBCString   in_szName
 

Sets the name of the file to be used, needed because the FTK receives the name, but it is the last filter that will open the file, so it has to be passed down from filter to filter.

Parameters:
in_szName  Name of the filter.

void CXSIFilter::SetSubFilter CXSIFilter *    in_pSub [inline]
 

Sets sub filter, used during construction.

Parameters:
in_pSub  sub filter to use.

int CXSIFilter::Tell   [virtual]
 

Returns the current position in the file.

Returns:
int position in the file (0 - beginning)

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

int CXSIFilter::Write SI_Char *    in_pBuffer,
SI_Long    in_lSize
[virtual]
 

Writes a number of bytes to the file

Parameters:
in_pBuffer  input buffer
in_lSize  number of bytes to write
Returns:
int number of bytes written

Reimplemented in CASCIIFilter, CBINFilter, CBufferFilter, and CLegacyFilter.

void CXSIFilter::WriteHeader   [virtual]
 

Writes out the header, this is called when we are about to write the file, to make sure the header is the first thing written in the file.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.