OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::KeyValueIdentifier Class Reference

#include <SqlFileTimeSeriesQuery.hpp>

Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ KeyValueIdentifier() [1/3]

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

Construct from single name.

◆ KeyValueIdentifier() [2/3]

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

Construct from multiple names.

Throws if names.size() == 0.

◆ KeyValueIdentifier() [3/3]

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

Construct from regex.

Member Function Documentation

◆ names()

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

Get name(s).

◆ regex()

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

Get regex, if it exists.