InspIRCd  3.0
Public Member Functions | List of all members
ClientProtocol::TagSelection Class Reference

#include <clientprotocol.h>

Public Member Functions

bool IsSelected (const TagMap &tags, TagMap::const_iterator it) const
 
void Select (const TagMap &tags, TagMap::const_iterator it)
 
bool operator== (const TagSelection &other) const
 

Detailed Description

A selection of zero or more tags in a TagMap.

Member Function Documentation

◆ IsSelected()

bool ClientProtocol::TagSelection::IsSelected ( const TagMap tags,
TagMap::const_iterator  it 
) const
inline

Check if a tag is selected.

Parameters
tagsTagMap the tag is in. The TagMap must contain the same tags as it had when the tag was selected with Select(), otherwise the result is not meaningful.
itIterator to the tag to check.
Returns
True if the tag is selected, false otherwise.

◆ operator==()

bool ClientProtocol::TagSelection::operator== ( const TagSelection other) const
inline

Check if a TagSelection is equivalent to this object.

Parameters
otherOther TagSelection object to compare this with.
Returns
True if the objects are equivalent, false if they aren't.

◆ Select()

void ClientProtocol::TagSelection::Select ( const TagMap tags,
TagMap::const_iterator  it 
)
inline

Select a tag.

Parameters
tagsTagMap the tag is in. This parameter must be the same every time the method is called. The TagMap must not be altered otherwise the results of IsSelected() is not meaningful.
itIterator to the tag to mark as selected.

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