mi::shader_v3::Map_status Class Reference

Map_status class. More...

#include <shader_map.h>

List of all members.

Public Types
enum	Status_code {    OK = 0,    Insufficient_memory,    No_such_field,    Out_of_bounds,    No_declaration,    Declaration_mismatch,    Wrong_dimension,    File_could_not_be_opened = 16,    File_not_a_map,    File_version_unsupported,    Field_undefined = 32,    Field_name_too_long,    Field_name_empty,    Field_name_illegal,    Field_null_array,    Field_type_mismatch,    Field_illegal,    Iterator_invalid = 48,    Iterator_past_end,    Iterator_out_of_bounds,    Lookup_invalid = 64,    Lookup_past_end,    Lookup_out_of_bounds,    Lookup_dimension_mismatch }
	all the status codes. More...
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.

---

Member Enumeration Documentation

enum mi::shader_v3::Map_status::Status_code

all the status codes.

Enumerator:

OK	OK.
Insufficient_memory	out of memory
No_such_field	the specified field doesn't exist
Out_of_bounds	map element index is out of bounds
No_declaration	map or map element with no declaration
Declaration_mismatch	differing declarations
Wrong_dimension	wrong dimension for map element
File_could_not_be_opened	I/O error.
File_not_a_map	the specified file is not a map
File_version_unsupported	unsupported map version in map file
Field_undefined	undefined map field type
Field_name_too_long	map field name is too long
Field_name_empty	empty map field name
Field_name_illegal	illegal name for map field
Field_null_array	array with zero length
Field_type_mismatch	get/set field value of the wrong type
Field_illegal	illegal field
Iterator_invalid	map iterator not attached to a map
Iterator_past_end	map iterator past the end
Iterator_out_of_bounds	map iterator is out of bounds
Lookup_invalid	map lookup not attached to a map
Lookup_past_end	map lookup past the end
Lookup_out_of_bounds	map lookup is out of bounds
Lookup_dimension_mismatch	dist functor for search has wrong dim

---

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

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

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

References m_status.

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

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

References m_status.

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

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

References m_status.

bool mi::shader_v3::Map_status::is_ok

(

)

const [inline]

returns if the status is OK or not.

Returns:

a boolean

References OK.

Status_code mi::shader_v3::Map_status::status

(

)

const [inline]

returns the status code as Status_code.

Returns:

the status code as Status_code