Aegis  4.25.D505
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
output_bit_bucket Class Reference

#include <bit_bucket.h>

Inheritance diagram for output_bit_bucket:
output

Public Member Functions

virtual ~output_bit_bucket ()

Static Public Member Functions

static pointer create (void)

Protected Member Functions

nstring filename (void) const
nstring type_name (void) const
long int ftell_inner (void) const
void write_inner (const void *data, size_t length)
void end_of_line_inner (void)
int page_width (void) const
int page_length (void) const

Private Member Functions

 output_bit_bucket ()
 output_bit_bucket (const output_bit_bucket &)
output_bit_bucketoperator= (const output_bit_bucket &)

Private Attributes

nstring file_name
long pos

Detailed Description

The output_bit_bucket class represents a NULL output stream. The output written to such a stream will be discarded.

Definition at line 29 of file bit_bucket.h.


Constructor & Destructor Documentation

The destructor.

The default constructor. It is private on purpose, use the "create" class method instead.

The copy constructor. Do not use.


Member Function Documentation

static pointer output_bit_bucket::create ( void  ) [static]

The create class method is used to create new dynamically allocated instances of this class.

void output_bit_bucket::end_of_line_inner ( void  ) [protected, virtual]

The end_of_line_inner method is used to ensure that the current output position is at the beginning of a line, without taking the buffering into account.

Implements output.

nstring output_bit_bucket::filename ( void  ) const [protected, virtual]

The filename method is used to obtain the filename of this output.

Implements output.

long int output_bit_bucket::ftell_inner ( void  ) const [protected, virtual]

The ftell_inner method is used to determine the current file position, without taking the buffering into account.

Implements output.

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

The copy constructor. Do not use.

int output_bit_bucket::page_length ( void  ) const [protected, virtual]

The page_length method is used to obtain the length of the page of the output device.

Reimplemented from output.

int output_bit_bucket::page_width ( void  ) const [protected, virtual]

The page_width method is used to obtain the width of the page of the output device.

Reimplemented from output.

nstring output_bit_bucket::type_name ( void  ) const [protected, virtual]

The type_name method is used to determine the name of this output device or file or type.

Implements output.

void output_bit_bucket::write_inner ( const void *  data,
size_t  length 
) [protected, virtual]

The write_inner method is used write data to the output, without taking the buffering into account.

Implements output.


Field Documentation

The file_name instance variable is used to remember the name of this "file".

Definition at line 79 of file bit_bucket.h.

long output_bit_bucket::pos [private]

The pos instance variable is used to remember the current output position.

Definition at line 85 of file bit_bucket.h.


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