PathPatternLocatorTraits
PathPatternLocatorTraits
Section titled “PathPatternLocatorTraits”#include <sbio/locators/path_pattern.hh>template<typename FTraits>struct PathPatternLocatorTraitsDefined in src/lib/sbio/locators/path_pattern.hh:44
Public Static Attributes
Section titled “Public Static Attributes”| Return | Name | Description |
|---|---|---|
constexpr std::size_t |
VariantCount static constexpr |
|
constexpr std::array< const char *, VariantCount > |
role_patterns static constexpr |
VariantCount
Section titled “VariantCount”static constexpr
constexpr std::size_t VariantCount { FTraits::StreamTypes::size() }Defined in src/lib/sbio/locators/path_pattern.hh:47
role_patterns
Section titled “role_patterns”static constexpr
constexpr std::array< const char *, VariantCount > role_patterns {}Type: constexpr std::array< const char *, VariantCount >
Defined in src/lib/sbio/locators/path_pattern.hh:49
Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
std::size_t |
id_stream static inline |
Given a filename, determine the stream identifier number. |
std::size_t |
id_chain_order static inline |
Given a filename, determine the stream’s order in a processing chain. |
id_stream
Section titled “id_stream”static inline
static inline std::size_t id_stream(std::string_view filename)Defined in src/lib/sbio/locators/path_pattern.hh:64
Given a filename, determine the stream identifier number.
If the format allows for multiple streams, it must assign a numeric value to them, even if it is not encoded directly in the filename. Additionally, if there are multiple stream roles which must be grouped together under a single StreamBroker for processing, the stream identifiers must match for the roles that will be grouped.
Returns
Section titled “Returns”A numeric identifier for the stream. This is unique within a single role, but different roles may, and should, have streams with the same identifier when they must be grouped together.
id_chain_order
Section titled “id_chain_order”static inline
static inline std::size_t id_chain_order(std::string_view filename)Defined in src/lib/sbio/locators/path_pattern.hh:78
Given a filename, determine the stream’s order in a processing chain.
Some formats allow, or require, streams to be processed in sequence. The chain identifier positions a given stream in the correct order of the processing sequence. E.g., chain id 0 will be processed, then chain id 1, and so on. As with the stream identifiers, if there are multiple roles that must be grouped together, the streams corresponding to different roles must have matched chain identifiers to ensure proper grouping.
Returns
Section titled “Returns”A numeric identifier for the stream’s position in a sequence/chain.
Public Types
Section titled “Public Types”| Name | Description |
|---|---|
Parameters |
Parameters
Section titled “Parameters”using Parameters = LocatorParameters_t< PathPatternLocator, FTraits >Type: LocatorParameters_t< PathPatternLocator, FTraits >
Defined in src/lib/sbio/locators/path_pattern.hh:45