OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
osvr::common::elements::AliasElement Class Reference

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 <osvr/Common/PathElementTypes.h>

Inheritance diagram for osvr::common::elements::AliasElement:
osvr::common::elements::ElementBase< AliasElement >

Public Member Functions

 AliasElement (std::string const &source, AliasPriority priority)
 Constructor with source and priority.
 
 AliasElement (std::string const &source)
 Constructor with source.
 
 AliasElement ()
 default constructor
 
void setSource (std::string const &source)
 Sets the source of this alias. More...
 
std::string & getSource ()
 Get the source of data for this alias.
 
std::string const & getSource () const
 
AliasPriority & priority ()
 Get/set whether this alias was automatically set (and thus subject to being override by explicit routing)
 
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< AliasElementbase_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.

Definition at line 173 of file PathElementTypes.h.

Member Function Documentation

void osvr::common::elements::AliasElement::setSource ( std::string const &  source)

Sets the source of this alias.

Parameters
sourceabsolute path of the target, possibly wrapped in transforms.
Todo:
support relative paths - either here or at a different level
Todo:
validation?

Definition at line 69 of file PathElementTypes.cpp.

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.

Definition at line 75 of file PathElementTypes.cpp.

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.

Definition at line 78 of file PathElementTypes.cpp.


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