Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

Bar Class Reference

A derived class. More...

#include <Bar.h>

Inheritance diagram for Bar:

Inheritance graph
[legend]
Collaboration diagram for Bar:

Collaboration graph
[legend]
List of all members.

Public Methods

 Bar (double a, int b)
 This constructor takes two arguments and serves as a suggested example of how ALMA methods should be documented. More...

 ~Bar ()
 destructor. More...

These methods belong together
void transmogriphierLoad (int profile)
 Calvin's transmogriphier must be loaded. More...

int transmogriphierUnload (void)
 the transmogriphier must be unloaded after usage. More...

void transmogriphierStart (void)
 this activates the transmogriphier. More...


Public Attributes

Parameters
double a
 the first parameter. More...

int b
 a second parameter. More...


Detailed Description

A derived class.

Here we show inheritance from a single docified class. This example shows how to structure the members of a class, if desired.

@include: Function.h @include: Intermediate.h

See also:
Foo


Constructor & Destructor Documentation

Bar::Bar ( double a,
int b )
 

This constructor takes two arguments and serves as a suggested example of how ALMA methods should be documented.

It demonstrates documenting parameters exceptions, return values, and pre- and post- conditions.

Parameters:
a   this is good for many things
b   this is good for nothing
Returns:
A Bar, whatever that is.
Exceptions:
None  
Precondition:
None required
Postcondition:
Whatever must happen next

Bar::~Bar ( )
 

destructor.


Member Function Documentation

void Bar::transmogriphierLoad ( int profile )
 

Calvin's transmogriphier must be loaded.

void Bar::transmogriphierStart ( void )
 

this activates the transmogriphier.

int Bar::transmogriphierUnload ( void )
 

the transmogriphier must be unloaded after usage.


Member Data Documentation

double Bar::a
 

the first parameter.

int Bar::b
 

a second parameter.


The documentation for this class was generated from the following file: ALMA Bar class Reference, 10 Aug 2001, generate with doxygen 1.2.8.1, for alma
ALMA Computing Group, ALMA homepage