cgal/BGL/doc_tex/BGL_ref/PropertyMap.tex

63 lines
2.2 KiB
TeX

%% Copyright (c) 2004 SciSoft. All rights reserved.
%%
%% This file is part of CGAL (www.cgal.org); you may redistribute it under
%% the terms of the Q Public License version 1.0.
%% See the file LICENSE.QPL distributed with CGAL.
%%
%% Licensees holding a valid commercial license may use this file in
%% accordance with the commercial license agreement provided with the software.
%%
%% This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
%% WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
%%
%%
%%
%% Author(s) : Fernando Cacciola <fernando_cacciola@hotmail.com>
\begin{ccRefConcept}{PropertyMap}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
The concept \ccRefName\ describes the requirements of a property map of the
\ccAnchor{http://www.boost.org/libs/property_map/property_map.html}{Boost Property Map Library}.
\ccTypes
\ccNestedType{category} {The category of the property (read-only, read-write or lvalue).}{}
\ccNestedType{value_type} {The type of the property.}{}
\ccNestedType{reference} {The result type of the map operator.}{}
\ccNestedType{key_type} {The key type of the map operator.}{}
\ccCreation
\ccCreationVariable{pm} %% choose variable name
\ccOperations
\ccMethod
{reference operator[]( key_type const& key ) const;}
{Returns the property associated with the given \ccc{key}.}
\ccHasModels
\ccRefIdfierPage{CGAL::Edge_is_border_property} \\
\ccRefIdfierPage{CGAL::Vertex_is_border_property} \\
\ccRefIdfierPage{CGAL::Vertex_point_property} \\
\ccRefIdfierPage{CGAL::Polyhedron_edge_weight_map<Traits> }\\
\ccRefIdfierPage{CGAL::Polyhedron_edge_is_border_map<Traits> }\\
\ccRefIdfierPage{CGAL::Polyhedron_vertex_is_border_map<Traits> }\\
\ccRefIdfierPage{CGAL::Polyhedron_vertex_point_const_map<Traits> }\\
\ccRefIdfierPage{CGAL::Polyhedron_vertex_point_map<Traits> }\\
\end{ccRefConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+