input_null Class Reference

#include <null.h>

Inheritance diagram for input_null:

input_ty

Public Member Functions

virtual ~input_null ()
 input_null ()
nstring name ()
long length ()
long read_inner (void *data, size_t nbytes)
long ftell_inner ()

Private Member Functions

 input_null (const input_null &)
input_nulloperator= (const input_null &)

Detailed Description

The input_null class is used to represent and input which is always empty.

Definition at line 29 of file null.h.


Constructor & Destructor Documentation

virtual input_null::~input_null (  )  [virtual]

The destructor.

input_null::input_null (  ) 

The default constructor.

input_null::input_null ( const input_null  )  [private]

The copy constructor. Do not use.


Member Function Documentation

nstring input_null::name (  )  [virtual]

The name method is used to determine the name of the input.

Implements input_ty.

long input_null::length (  )  [virtual]

The length method is used to determine the length of the input. May return -1 if the length is unknown.

Implements input_ty.

long input_null::read_inner ( void *  data,
size_t  nbytes 
) [virtual]

The read_inner method is used to read unbuffered data from the given input stream. At most nbytes bytes will be read into data. The number of bytes actually read will be returned. At end-of-file, a value <= 0 will be returned, and data will be unchanged. All file read errors or format errors are fatal, and will cause the method to not return.

Parameters:
data Where to put the results of the read.
nbytes The maximum number of bytes to read.
Returns:
The actual number of bytes read, or zero for end-of-file.

Implements input_ty.

long input_null::ftell_inner (  )  [virtual]

The ftell_inner method is used to determine the unbuffered current position within the input.

Implements input_ty.

input_null& input_null::operator= ( const input_null  )  [private]

The assignment operator. Do not use.


The documentation for this class was generated from the following file:

Generated on Wed Mar 12 23:37:40 2008 for Aegis by  doxygen 1.5.5