OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
openstudio::KeyValueIdentifier Class Reference

#include <SqlFileTimeSeriesQuery.hpp>

Public Member Functions

 KeyValueIdentifier (const std::string &name)
 Construct from single name. More...
 
 KeyValueIdentifier (const std::vector< std::string > &names)
 Construct from multiple names. More...
 
 KeyValueIdentifier (const boost::regex &re)
 Construct from regex. More...
 
std::vector< std::string > names () const
 Get name(s). More...
 
boost::optional< boost::regex > regex () const
 Get regex, if it exists. More...
 

Detailed Description

Small class to let users identify one or more key values by name or regex.

Constructor & Destructor Documentation

openstudio::KeyValueIdentifier::KeyValueIdentifier ( const std::string &  name)

Construct from single name.

openstudio::KeyValueIdentifier::KeyValueIdentifier ( const std::vector< std::string > &  names)

Construct from multiple names.

Throws if names.size() == 0.

openstudio::KeyValueIdentifier::KeyValueIdentifier ( const boost::regex &  re)

Construct from regex.

Member Function Documentation

std::vector<std::string> openstudio::KeyValueIdentifier::names ( ) const

Get name(s).

boost::optional<boost::regex> openstudio::KeyValueIdentifier::regex ( ) const

Get regex, if it exists.