ADTF File Library
Loading...
Searching...
No Matches
adtf_file::adtf3::SubstreamProperties Struct Reference

#include <substream_utilities.h>

Public Member Functions

bool operator== (const SubstreamProperties &rhs) const
 
std::shared_ptr< StreamTypecreateStreamType () const
 
void copyToStreamType (PropertyStreamType &type) const
 

Public Attributes

uint32_t id
 substream id
 
std::string stream_meta_type_name
 the name of the stream meta type
 
std::unordered_map< std::string, std::pair< std::string, std::string > > stream_type_properties
 all properties of the stream type
 

Detailed Description

Struct that stores all information of a substream.

Member Function Documentation

◆ copyToStreamType()

void adtf_file::adtf3::SubstreamProperties::copyToStreamType ( PropertyStreamType & type) const

Fills the given type with the type information of this substream.

Parameters
[out]typeThe type instance where the properties should be set.

◆ createStreamType()

std::shared_ptr< StreamType > adtf_file::adtf3::SubstreamProperties::createStreamType ( ) const
Returns
a StreamType created from the information stored within the struct.

◆ operator==()

bool adtf_file::adtf3::SubstreamProperties::operator== ( const SubstreamProperties & rhs) const

Check for equality

Parameters
[in]rhsInstance to compare this to.
Returns
Whether or not the other instance equals this.

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