The element type corresponding to a path alias, with a priority level for sorting out whether automatic routes should replace or update it. More...
#include <PathElementTypes.h>
Inheritance diagram for osvr::common::elements::AliasElement:
Public Member Functions | |
| OSVR_COMMON_EXPORT | AliasElement (std::string const &source, AliasPriority priority) |
| Constructor with source and priority. | |
| OSVR_COMMON_EXPORT | AliasElement (std::string const &source) |
| Constructor with source. | |
| AliasElement () | |
| default constructor | |
| OSVR_COMMON_EXPORT void | setSource (std::string const &source) |
| Sets the source of this alias. More... | |
| OSVR_COMMON_EXPORT std::string & | getSource () |
| Get the source of data for this alias. | |
| OSVR_COMMON_EXPORT std::string const & | getSource () const |
| OSVR_COMMON_EXPORT AliasPriority & | priority () |
| Get/set whether this alias was automatically set (and thus subject to being override by explicit routing) | |
| OSVR_COMMON_EXPORT AliasPriority | priority () const |
| bool | operator== (AliasElement const &rhs) const |
| Equality comparison operator. | |
 Public Member Functions inherited from osvr::common::elements::ElementBase< AliasElement > | |
| const char * | getTypeName () const |
Additional Inherited Members | |
| Public Types inherited from osvr::common::elements::ElementBase< AliasElement > | |
| typedef AliasElement | type |
| typedef ElementBase< AliasElement > | base_type |
| Protected Member Functions inherited from osvr::common::elements::ElementBase< AliasElement > | |
| ElementBase () | |
| Protected constructor to force subclassing. More... | |
Detailed Description
The element type corresponding to a path alias, with a priority level for sorting out whether automatic routes should replace or update it.
This is a "shallow" alias - does not link to children.
Member Function Documentation
§ getSource()
| std::string const & osvr::common::elements::AliasElement::getSource | ( | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
§ priority()
| AliasPriority osvr::common::elements::AliasElement::priority | ( | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
§ setSource()
| void osvr::common::elements::AliasElement::setSource | ( | std::string const & | source | ) |
The documentation for this class was generated from the following files:
- inc/osvr/Common/PathElementTypes.h
- src/osvr/Common/PathElementTypes.cpp
