#include <filter_criteria.hpp>
Public Member Functions | |
FilterCriteria (const std::string &world) | |
FilterCriteria (const std::string &world, const std::vector< std::string > &uuids, const std::vector< std::string > &names, const std::vector< std::string > &types, const std::vector< std::string > &keywords, const std::vector< std::string > &relationships) | |
std::vector< std::string > | getKeywords () const |
std::vector< std::string > | getNames () const |
std::vector< UniqueIDmsg > | getRelationships () const |
std::vector< std::string > | getTypes () const |
std::vector< UniqueIDmsg > | getUuids () const |
std::string | getWorld () const |
bool | nullFilter () |
void | setKeywords (const std::vector< std::string > &keywords) |
void | setNames (const std::vector< std::string > &names) |
void | setRelationships (const std::vector< std::string > &relationships) |
void | setTypes (const std::vector< std::string > &types) |
void | setUuids (const std::vector< std::string > &uuids) |
void | setWorld (const std::string &world) |
virtual | ~FilterCriteria () |
Private Attributes | |
std::vector< std::string > | keywords |
std::vector< std::string > | names |
std::vector< UniqueIDmsg > | relationships |
std::vector< std::string > | types |
std::vector< UniqueIDmsg > | uuids |
std::string | world |
Annotations filter criteria to pass to the world canvas server. The only mandatory criteria is the world name. Empty vectors are ignored; the non-empty are concatenated with logic ANDs. Within the lists, elements are concatenated with logic ORs, so for example an annotation only needs to contain one of the keywords to be retrieved.
Definition at line 28 of file filter_criteria.hpp.
wcf::FilterCriteria::FilterCriteria | ( | const std::string & | world | ) |
Creates an empty filter criteria set.
Definition at line 15 of file filter_criteria.cpp.
wcf::FilterCriteria::FilterCriteria | ( | const std::string & | world, |
const std::vector< std::string > & | uuids, | ||
const std::vector< std::string > & | names, | ||
const std::vector< std::string > & | types, | ||
const std::vector< std::string > & | keywords, | ||
const std::vector< std::string > & | relationships | ||
) |
Creates a filter criteria set at one blow.
uuids,: | Filter annotations by their uuid |
names,: | Filter annotations by their name |
types,: | Filter annotations by their type |
keywords,: | Filter annotations by their keywords |
relationships,: | Filter annotations by their relationships |
Definition at line 20 of file filter_criteria.cpp.
wcf::FilterCriteria::~FilterCriteria | ( | ) | [virtual] |
Definition at line 35 of file filter_criteria.cpp.
std::vector<std::string> wcf::FilterCriteria::getKeywords | ( | ) | const [inline] |
Definition at line 75 of file filter_criteria.hpp.
std::vector<std::string> wcf::FilterCriteria::getNames | ( | ) | const [inline] |
Definition at line 73 of file filter_criteria.hpp.
std::vector<UniqueIDmsg> wcf::FilterCriteria::getRelationships | ( | ) | const [inline] |
Definition at line 76 of file filter_criteria.hpp.
std::vector<std::string> wcf::FilterCriteria::getTypes | ( | ) | const [inline] |
Definition at line 74 of file filter_criteria.hpp.
std::vector<UniqueIDmsg> wcf::FilterCriteria::getUuids | ( | ) | const [inline] |
Definition at line 72 of file filter_criteria.hpp.
std::string wcf::FilterCriteria::getWorld | ( | ) | const [inline] |
Definition at line 71 of file filter_criteria.hpp.
bool wcf::FilterCriteria::nullFilter | ( | ) |
Definition at line 39 of file filter_criteria.cpp.
void wcf::FilterCriteria::setKeywords | ( | const std::vector< std::string > & | keywords | ) |
Definition at line 67 of file filter_criteria.cpp.
void wcf::FilterCriteria::setNames | ( | const std::vector< std::string > & | names | ) |
Definition at line 57 of file filter_criteria.cpp.
void wcf::FilterCriteria::setRelationships | ( | const std::vector< std::string > & | relationships | ) |
Definition at line 72 of file filter_criteria.cpp.
void wcf::FilterCriteria::setTypes | ( | const std::vector< std::string > & | types | ) |
Definition at line 62 of file filter_criteria.cpp.
void wcf::FilterCriteria::setUuids | ( | const std::vector< std::string > & | uuids | ) |
Definition at line 50 of file filter_criteria.cpp.
void wcf::FilterCriteria::setWorld | ( | const std::string & | world | ) |
Definition at line 45 of file filter_criteria.cpp.
std::vector<std::string> wcf::FilterCriteria::keywords [private] |
Definition at line 35 of file filter_criteria.hpp.
std::vector<std::string> wcf::FilterCriteria::names [private] |
Definition at line 33 of file filter_criteria.hpp.
std::vector<UniqueIDmsg> wcf::FilterCriteria::relationships [private] |
Definition at line 36 of file filter_criteria.hpp.
std::vector<std::string> wcf::FilterCriteria::types [private] |
Definition at line 34 of file filter_criteria.hpp.
std::vector<UniqueIDmsg> wcf::FilterCriteria::uuids [private] |
Definition at line 32 of file filter_criteria.hpp.
std::string wcf::FilterCriteria::world [private] |
Definition at line 31 of file filter_criteria.hpp.