RTI Routing Service  Version 6.0.0
 All Data Structures Files Functions Typedefs Enumerations Enumerator Groups Pages
rti::routing::StreamInfo Class Reference

Definition of the stream information that RTI Routing Service needs to manage user data streams. More...

#include <StreamInfo.hpp>

Inherits NativeValueType< StreamInfo >.

Public Member Functions

 StreamInfo (const std::string &the_stream_name, const std::string &the_type_name)
 Constructs a StreamInfo with the minimum required information.
 
bool disposed () const
 Getter (see setter with the same name)
 
StreamInfodisposed (bool the_disposed)
 Sets the dispose flag in this object.
 
std::string stream_name () const
 Getter (see setter with the same name)
 
StreamInfostream_name (const std::string &the_stream_name)
 Sets the name of the stream.
 
TypeInfotype_info ()
 Getter (see setter with the same name)
 
const TypeInfotype_info () const
 Sets the type information associated with the stream.
 

Detailed Description

Definition of the stream information that RTI Routing Service needs to manage user data streams.

A stream in RTI Routing Service is a typed data channel to consume/produce data in a data domain.

Constructor & Destructor Documentation

rti::routing::StreamInfo::StreamInfo ( const std::string &  the_stream_name,
const std::string &  the_type_name 
)
inline

Constructs a StreamInfo with the minimum required information.

Parameters
the_stream_name<<in>> The name of the stream.
the_type_name<<in>> The name of the type associated with the data in the stream.

References stream_name(), type_info(), and rti::routing::TypeInfo::type_name().

Member Function Documentation

bool rti::routing::StreamInfo::disposed ( ) const
inline

Getter (see setter with the same name)

StreamInfo& rti::routing::StreamInfo::disposed ( bool  the_disposed)
inline

Sets the dispose flag in this object.

Indicates whether the stream is a newly discovered stream or a disposed stream that no longer exists.

Parameters
the_disposed<<in>> true if the stream is marked as disposed or false otherwise.
std::string rti::routing::StreamInfo::stream_name ( ) const
inline

Getter (see setter with the same name)

Referenced by stream_name(), and StreamInfo().

StreamInfo& rti::routing::StreamInfo::stream_name ( const std::string &  the_stream_name)
inline

Sets the name of the stream.

Parameters
the_stream_name<<in>> Name of the stream.

References stream_name().

TypeInfo& rti::routing::StreamInfo::type_info ( )
inline

Getter (see setter with the same name)

Referenced by StreamInfo().

const TypeInfo& rti::routing::StreamInfo::type_info ( ) const
inline

Sets the type information associated with the stream.

See Also
TypeInfo.

RTI Routing Service Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc