adtf_file_library  0.13.1
Public Member Functions | List of all members
adtf_file::PropertyStreamType Class Referenceabstract

The default interface class for stream types. More...

#include <stream_type.h>

Inheritance diagram for adtf_file::PropertyStreamType:
[legend]

Public Member Functions

virtual void setMetaType (const std::string &meta_type)=0
 Set the Meta Type. More...
 
virtual PropertyStreamTypesetProperty (const std::string &name, const std::string &type, const std::string &value)=0
 Set a Property. More...
 
virtual std::string getMetaType () const =0
 Get the Meta Type. More...
 
virtual std::pair< std::string, std::string > getProperty (const std::string &name) const =0
 Get a Property. More...
 
virtual void iterateProperties (std::function< void(const char *, const char *, const char *)> functor) const =0
 iterates the properties More...
 

Detailed Description

The default interface class for stream types.

Member Function Documentation

◆ getMetaType()

virtual std::string adtf_file::PropertyStreamType::getMetaType ( ) const
pure virtual

Get the Meta Type.

Returns
std::string

Implemented in adtf_file::DefaultStreamType.

◆ getProperty()

virtual std::pair<std::string, std::string> adtf_file::PropertyStreamType::getProperty ( const std::string &  name) const
pure virtual

Get a Property.

Parameters
namethe name of the property
Returns
std::pair<std::string, std::string> the type, value pair

Implemented in adtf_file::DefaultStreamType.

◆ iterateProperties()

virtual void adtf_file::PropertyStreamType::iterateProperties ( std::function< void(const char *, const char *, const char *)>  functor) const
pure virtual

iterates the properties

Parameters
functorthe function to call for each property

Implemented in adtf_file::DefaultStreamType.

◆ setMetaType()

virtual void adtf_file::PropertyStreamType::setMetaType ( const std::string &  meta_type)
pure virtual

Set the Meta Type.

Parameters
meta_typethe meta type of the stream type

Implemented in adtf_file::DefaultStreamType.

◆ setProperty()

virtual PropertyStreamType& adtf_file::PropertyStreamType::setProperty ( const std::string &  name,
const std::string &  type,
const std::string &  value 
)
pure virtual

Set a Property.

Parameters
namename of the property
typetype of the property
valuevalue f the property as string
Returns
*this

Implemented in adtf_file::DefaultStreamType.


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

Copyright © CARIAD SE.
Generated on Fri Apr 19 2024 by doxygen 1.9.1
GIT Commit Hash: 82d535f82776c20b12fc60740bdae991b62444a7