mi::shader::Map Class Reference

Map class. More...

#include <shader_map.h>

List of all members.

Public Member Functions

virtual miUint size () const =0
 returns the number of elements
virtual bool is_empty () const =0
 returns true if the map is empty
virtual bool has_declaration () const =0
 returns true if the map has a declaration
virtual Map_status get (const miUint index, Map_element_handle &map_element) const =0
 gets a copy of an element
virtual Map_status set (const miUint index, const Map_element_handle &map_element)=0
 sets the desired element
virtual Map_status append (const Map_element_handle &map_element)=0
 appends the desired element at the end
virtual Map_status read (const char *file_name)=0
 reads a map from a file
virtual Map_status append_to (const char *file_name)=0
 appends the map to the existing file
virtual Map_status append_from (const char *file_name)=0
 appends the contents of the file to the map
virtual Map_status write (const char *file_name)=0
 writes the map to file

Detailed Description

Map class.

The Map class is an abstract class which provides access to a map, to its elements through the use of get/set methods and to its declaration.

Member Function Documentation

virtual Map_status mi::shader::Map::append (  const Map_element_handle &  map_element  )  [pure virtual]
 

appends the desired element at the end

Parameters:
map_element is the Map_element handle
Returns:
a status code

virtual Map_status mi::shader::Map::append_from (  const char *  file_name  )  [pure virtual]
 

appends the contents of the file to the map

Parameters:
file_name is the name of the file to read
Returns:
a status code

virtual Map_status mi::shader::Map::append_to (  const char *  file_name  )  [pure virtual]
 

appends the map to the existing file

Parameters:
file_name is the name of the file to append to
Returns:
a status code

virtual Map_status mi::shader::Map::get (  const miUint  index,
Map_element_handle &  map_element
)  const [pure virtual]
 

gets a copy of an element

Parameters:
index is the desired element index
map_element is the Map_element handle
Returns:
a status code

virtual Map_status mi::shader::Map::read (  const char *  file_name  )  [pure virtual]
 

reads a map from a file

Parameters:
file_name is the name of the file to read
Returns:
a status code

virtual Map_status mi::shader::Map::set (  const miUint  index,
const Map_element_handle &  map_element
)  [pure virtual]
 

sets the desired element

Parameters:
index is the desired element index
map_element is the Map_element handle
Returns:
a status code

virtual Map_status mi::shader::Map::write (  const char *  file_name  )  [pure virtual]
 

writes the map to file

Parameters:
file_name is the name of the file to write
Returns:
a status code

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

Copyright © 1986-2008 by mental images GmbH