ADTF  3.13.0
stream_meta_type_substreams

Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type - see also Substreams. More...

Public Member Functions

 stream_meta_type_substreams ()=default
 Default CTOR.
 

Static Public Member Functions

static tVoid SetProperties (const adtf::ucom::ant::iobject_ptr< adtf::base::ant::IProperties > &pProperties)
 Sets the default properties to the given pProperties. More...
 
static tResult IsCompatible (const adtf::streaming::ant::IStreamType &oTypeToCheck, const adtf::streaming::ant::IStreamType &oTypeExpected)
 Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types in ADTF for a summary of implementations. More...
 
static tBool HasSubStreams (const ant::IStreamType &oStreamType)
 
static tVoid ListSubStreams (const ant::IStreamType &oStreamType, std::function< void(const tChar *)> fnCallback)
 List all available Substreams. More...
 
static tVoid ListSubStreams (const ant::IStreamType &oStreamType, std::function< void(const tChar *, tUInt32)> fnCallback)
 List all available Substreams. More...
 
static tUInt32 GetSubStreamId (const ant::IStreamType &oStreamType, const tChar *strSubStreamName)
 Returns the Substream id of a given Substream. More...
 
static ucom::ant::object_ptr< const ant::IStreamTypeGetSubStreamType (const ant::IStreamType &oStreamType, const tChar *strSubStreamName)
 Extracts the Stream Type of a specific Substream. More...
 
static tVoid GetRequestProperties (base::ant::IProperties &oProperties, const ant::IStreamType &oStreamType, const tChar *strSubStreamName="")
 Extracts the common or Substream specific request Properties. More...
 

Static Public Attributes

static constexpr const tChar *const MetaTypeName = "adtf/substreams"
 The unique name of this meta type.
 
static constexpr const tChar *const SubStreams = "substreams"
 The name of the substreams property. More...
 
static constexpr const tChar *const SubStreamsRequestProperties = "substreams_request_properties"
 The name of the substreams request property. More...
 

Detailed Description

Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type - see also Substreams.

This concept class for describing "adtf/substreams" Stream Types is not used for the genrator class Stream Meta Type. Use the cSubStreamTypes implemetation instead. Data Pipes using Substreams will use this type to identify each single sample which will belong to a specific substream and its sub type. Have a look at Substreams.

Definition at line 30 of file streammetatypesubstreams.h.

Member Function Documentation

◆ GetRequestProperties()

static tVoid GetRequestProperties ( base::ant::IProperties oProperties,
const ant::IStreamType oStreamType,
const tChar strSubStreamName = "" 
)
static

Extracts the common or Substream specific request Properties.

Parameters
[out]oPropertiesThe request Properties will be added to this object.
[in]oStreamTypeThe Stream Type.
[in]strSubStreamNameThe name of the Substream. If empty the common request properties will be retrieved.

◆ GetSubStreamId()

static tUInt32 GetSubStreamId ( const ant::IStreamType oStreamType,
const tChar strSubStreamName 
)
static

Returns the Substream id of a given Substream.

Parameters
[in]oStreamTypeThe Stream Type.
[in]strSubStreamNameThe name of the Substream.
Returns
The Substream id.
Exceptions
tResultin case that the id could not be retrieved.

◆ GetSubStreamType()

static ucom::ant::object_ptr<const ant::IStreamType> GetSubStreamType ( const ant::IStreamType oStreamType,
const tChar strSubStreamName 
)
static

Extracts the Stream Type of a specific Substream.

Parameters
[in]oStreamTypeThe Stream Type.
[in]strSubStreamNameThe name of the Substream.
Returns
The Stream Type.
Exceptions
tResultin case that Stream Type could not be retrieved.

◆ HasSubStreams()

static tBool HasSubStreams ( const ant::IStreamType oStreamType)
static
Parameters
[in]oStreamTypeThe Stream Type
Returns
True if the stream type has substreams

◆ IsCompatible()

static tResult IsCompatible ( const adtf::streaming::ant::IStreamType oTypeToCheck,
const adtf::streaming::ant::IStreamType oTypeExpected 
)
static

Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types in ADTF for a summary of implementations.

This implementation of IsCompatible will accept all other Meta Types and will return ERR_NOERROR only if:

  • Property SubStreams are equal
  • the all existing SubstreamName in oTypeExpected also exists in oTypeToCheck (Currently no the metatype of the Substream ist not checked)
Remarks
For a complete definition of the delivered default types and the information of which Stream Type is compatible to another one then see Default Stream Meta Types in ADTF.
Parameters
[in]oTypeToCheckThe incoming type to check.
[in]oTypeExpectedThe expected type which values are more significant.
Return values
ERR_NOERRORtypes are compatible
See also
Default Stream Meta Types in ADTF, AcceptType and IsCompatible implementations.

◆ ListSubStreams() [1/2]

static tVoid ListSubStreams ( const ant::IStreamType oStreamType,
std::function< void(const tChar *)>  fnCallback 
)
static

List all available Substreams.

Parameters
[in]oStreamTypeThe Stream Type
[out]fnCallbackThis is called for each available Substream with the stream name.

◆ ListSubStreams() [2/2]

static tVoid ListSubStreams ( const ant::IStreamType oStreamType,
std::function< void(const tChar *, tUInt32)>  fnCallback 
)
static

List all available Substreams.

Parameters
[in]oStreamTypeThe Stream Type
[out]fnCallbackThis is called for each available Substream with the stream name and id.

◆ SetProperties()

static tVoid SetProperties ( const adtf::ucom::ant::iobject_ptr< adtf::base::ant::IProperties > &  pProperties)
static

Sets the default properties to the given pProperties.

Parameters
pPropertiesThe properties where to set the default properties to

Member Data Documentation

◆ SubStreams

constexpr const tChar* const SubStreams = "substreams"
static

The name of the substreams property.

This Property determine if substreams are supported or not (tTrue or tFalse). Subproperties will identify the concreate Substream Type.

Definition at line 44 of file streammetatypesubstreams.h.

◆ SubStreamsRequestProperties

constexpr const tChar* const SubStreamsRequestProperties = "substreams_request_properties"
static

The name of the substreams request property.

This Property determine if substreams are requestable and currently requested.

Definition at line 49 of file streammetatypesubstreams.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Sep 28 2021 by doxygen 1.8.14)