pandore::Errc

pandore::Errc Class Reference

#include <errc.h>

List of all members.

Detailed Description

A type that contains any primitive type value.

The class Errc defines a type of any value type. It can be set with any primitive type value (Uchar, Slong, Float, bool, ... - Except int) or one of the predefined values: SUCCESS or FAILURE.

The actual type of Errc is defined by setting.
For example, the following lines set the variable a to the integer 12 and then change it to the predefined value SUCCESS or to the float value 12.5: 

 Errc a; a=12;
 if (a==12) then a=SUCCESS else a=12.5;

This type mainly used for the return type of the operator functions: 

 Errc function(<parameters>*) {
    < instruction >*;
    return SUCCESS;
 }


Public Member Functions

Errc & operator= (const Errc &error)
bool operator! ()
void Exit () const

Friends

bool operator && (Errc &e1, Errc &e2)
bool operator && (Errc &e, bool b)
bool operator && (bool b, Errc &e)
bool operator|| (Errc &e1, Errc &e2)
bool operator|| (Errc &e, bool b)
bool operator|| (bool b, Errc &e)

Member Function Documentation

void pandore::Errc::Exit (   )  const
 

Terminates the current execution and returns the current value as the error code. Overloads the C-function exit(). The error code can then be read with the Pandore operator: pstatus.

bool pandore::Errc::operator! (   )  [inline]
 

Returns the logical negation of the current value.

Errc& pandore::Errc::operator= (  const Errc &  error  )  [inline]
 

Sets the error value with the specified value.

Parameters:
error the specified value

Friends And Related Function Documentation

bool operator && (  bool  b,
Errc &  e
)  [friend]
 

Performs logical et between an errc and a boolean.

Parameters:
b a boolean
e an errc.

bool operator && (  Errc &  e,
bool  b
)  [friend]
 

Performs logical et between an errc and a boolean.

Parameters:
e an errc.
b a boolean

bool operator && (  Errc &  e1,
Errc &  e2
)  [friend]
 

Performs logical et between 2 errc.

Parameters:
e1 the first operand.
e2 the second operand.

bool operator|| (  bool  b,
Errc &  e
)  [friend]
 

Performs logical or between an errc and a boolean.

Parameters:
b a boolean
e an errc.

bool operator|| (  Errc &  e,
bool  b
)  [friend]
 

Performs logical or between an errc and a boolean.

Parameters:
e an errc.
b a boolean

bool operator|| (  Errc &  e1,
Errc &  e2
)  [friend]
 

Performs logical or between 2 errc.

Parameters:
e1 the first operand.
e2 the second operand.

The documentation for this class was generated from the following file:
The Pantheon project
Image Team GREYC Laboratory
UMR CNRS 6072 - ENSICAEN - University of Caen, France
This page was last modified on 19 June 2015