#include <BCL.hpp>

Public Member Functions
	BCLFacet (const pugi::xml_node &facetElement)

std::string	field () const
	Field name of the facet to use during meta searches, e.g. More...

std::vector< std::pair < std::string, unsigned > >	items () const
	Possible values for the facet as well as the number of search results after applying each value, e.g. More...

std::string	label () const
	Human readable name of the facet, e.g. More...

Detailed Description

This gives information about items from a BCL facet from a meta search result.

A facet is an optional search filter which may be applied to narrow down search results.

Constructor & Destructor Documentation

openstudio::BCLFacet::BCLFacet ( const pugi::xml_node & facetElement )

std::string openstudio::BCLFacet::field ( ) const

Field name of the facet to use during meta searches, e.g.

'construction_type'

std::vector<std::pair<std::string, unsigned> > openstudio::BCLFacet::items ( ) const

Possible values for the facet as well as the number of search results after applying each value, e.g.

[['steel framed', 30], ['metal building', 21], ...]

std::string openstudio::BCLFacet::label ( ) const

Human readable name of the facet, e.g.

'Construction Type'