Polaris: OmegaInfo Class Reference

OmegaInfo Class Reference

a semantic equivalent of Info<void> More...

#include <OmegaInfo.h>

Inheritance diagram for OmegaInfo:

[legend]List of all members.


Public Member Functions
	OmegaInfo ()
	OmegaInfo (const OmegaInfo &other)
OmegaInfo &	operator= (const OmegaInfo &other)
virtual	~OmegaInfo ()
virtual int &	data ()
	Runtime ERROR to call this function! (there is NO data associated with OmegaInfo).
int &	data ()

Detailed Description

a semantic equivalent of Info<void>

Polaris Base

See also:: OmegaInfo.h
OmegaInfo.h

Description

Please first read the manual pages for Extra and Info.

Because, unfortunately, Info<void> is not useful, there is a special macro called OMEGA_INFO which is useful when you do not not need to pass in any extra info. This macro is based on a class called OmegaInfo, which is essentially a semantic equivalent for Info<void>. It can be useful when you have to create a function with an ExtraInfo& field (such as for the 'replace' function, see "Expression.replace.h"), but your function does not actually need or use that extra information. In that case, you may want to pass in the value of the macro OMEGA_INFO to your function to make it clear that this value is not actually being used.

Caveats

A paragraph describing unusual features of the class. This paragraph may be omitted.

Definition at line 47 of file OmegaInfo.h.

Constructor & Destructor Documentation

OmegaInfo::OmegaInfo ( ) [inline]

Definition at line 68 of file OmegaInfo.h.
References register_instance().

OmegaInfo::OmegaInfo ( const OmegaInfo & other ) [inline]

OmegaInfo::~OmegaInfo ( ) [virtual]

Definition at line 13 of file OmegaInfo.cc.
References unregister_instance().

Member Function Documentation

OmegaInfo& OmegaInfo::operator= ( const OmegaInfo & other ) [inline]

int & OmegaInfo::data ( ) [inline, virtual]

Runtime ERROR to call this function! (there is NO data associated with OmegaInfo).

Reimplemented from Info< int >.
Definition at line 22 of file OmegaInfo.cc.
References Info< T >::data().

int& OmegaInfo::data ( ) [inline, virtual]

Reimplemented from Info< int >.

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