Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
FBOrientationC::FBOrientationC(const FBOrientationT)
FBOrientationC::FBOrientationC(const FBOrientationC &)
FBOrientationC::Orientation(void) const
FBOrientationC::GetCode(int)
FBOrientationC::Opposite(void) const
FBOrientationC::Change(void)
FBOrientationC::Is(const FBOrientationT) const
FBOrientationC::operator==(const FBOrientationC &) const
FBOrientationC::operator!=(const FBOrientationC &) const
FBOrientationC::Is(const FBOrientationC::FBOrientationT) const
FBOrientationC
 
2 Direction orientation
 
include "amma/FBOrient.hh"
User Level:Default
Library:Mentity
Example:exComplx.cc
Section:Image.Indexing Basic Types.Indexing
In Scope:std

Comments:
The class FBOrientationC represents two state orientation.

Enumerated types:
enum FBOrientationT { FORWARD = 0, BACK = 1 } ;

Variables:
FBOrientationT where;
The current value of orientation.

Methods:
FBOrientationC(const FBOrientationT orient = FORWARD)
Creates the orientation 'orient'.

FBOrientationC(const FBOrientationC & orient)
Copy constructor. Access to the state of the object. ----------------------------------

FBOrientationT Orientation() const
Returns the current value of the orientation.

FBOrientationT GetCode(int i)
Returns the orientation related to the index 'i'. Changing of the state. ----------------------

FBOrientationT Opposite() const
Returns the opposite orientation of the current value.

FBOrientationC & Change()
Changes the orientation. Logical conditions. -------------------

BooleanT Is(const FBOrientationT orient = FORWARD) const
Returns TRUE if this orientation has the value 'orient'.

BooleanT operator==(const FBOrientationC & orient) const
Returns TRUE if both orientations have the same value.

BooleanT operator!=(const FBOrientationC & orient) const
Returns FALSE if this orientation has different value than the orientation 'orient'.

BooleanT Is(const FBOrientationC::FBOrientationT orient) const


Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001