mi::shader_v3::Map_status Class Reference

Map_status class. The Map_status is an enumerative class which is meant to list all possible error conditions for the Map-related classes and methods. More...

#include <shader_map.h>

List of all members.

Public Types

enum  Status_code
 all the status codes.

Public Member Functions

 Map_status ()
 constructor, initializes to OK.
 Map_status (Status_code status)
 constructor from a Status_code.
 Map_status (const Map_status &status)
 copy constructor.
Map_status & operator= (const Status_code &rhs)
 copy assignment operator (Status_code).
Map_status & operator= (const Map_status &rhs)
 copy assignment operator (Map_status).
bool operator== (const Status_code rhs) const
 equality operator (Status_code).
bool operator== (const Map_status &rhs) const
 equality operator (Map_status).
bool operator!= (const Status_code rhs) const
 inequality operator (Status_code).
bool operator!= (const Map_status &rhs) const
 inequality operator (Map_status).
bool is_ok () const
 returns if the status is OK or not.
Status_code status () const
 returns the status code as Status_code.

Detailed Description

Map_status class. The Map_status is an enumerative class which is meant to list all possible error conditions for the Map-related classes and methods.

Constructor & Destructor Documentation

mi::shader_v3::Map_status::Map_status (  Status_code  status  )  [inline]
 

constructor from a Status_code.

Parameters:
status is the assigned Status_code

mi::shader_v3::Map_status::Map_status (  const Map_status &  status  )  [inline]
 

copy constructor.

Parameters:
status is the Map_status to copy

Member Function Documentation

bool mi::shader_v3::Map_status::is_ok (   )  const [inline]
 

returns if the status is OK or not.

Returns:
a boolean

bool mi::shader_v3::Map_status::operator!= (  const Map_status &  rhs  )  const [inline]
 

inequality operator (Map_status).

Parameters:
rhs is the Map_status to compare to
Returns:
true if different, false if equal

bool mi::shader_v3::Map_status::operator!= (  const Status_code  rhs  )  const [inline]
 

inequality operator (Status_code).

Parameters:
rhs is the Status_code to compare to
Returns:
true if different, false if equal

Map_status& mi::shader_v3::Map_status::operator= (  const Map_status &  rhs  )  [inline]
 

copy assignment operator (Map_status).

Parameters:
rhs the Map_status to copy
Returns:
a reference to itself

Map_status& mi::shader_v3::Map_status::operator= (  const Status_code &  rhs  )  [inline]
 

copy assignment operator (Status_code).

Parameters:
rhs the Status_code to copy
Returns:
a reference to itself

bool mi::shader_v3::Map_status::operator== (  const Map_status &  rhs  )  const [inline]
 

equality operator (Map_status).

Parameters:
rhs is the Map_status to compare to
Returns:
true if equal, false if different

bool mi::shader_v3::Map_status::operator== (  const Status_code  rhs  )  const [inline]
 

equality operator (Status_code).

Parameters:
rhs is the Status_code to compare to
Returns:
true if equal, false if different

Status_code mi::shader_v3::Map_status::status (   )  const [inline]
 

returns the status code as Status_code.

Returns:
the status code as Status_code

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

Copyright © 1986-2008 by mental images GmbH