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 rti::core::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. More...
bool	disposed () const
	Getter (see setter with the same name) More...
StreamInfo &	disposed (bool the_disposed)
	Sets the dispose flag in this object. More...
std::string	stream_name () const
	Getter (see setter with the same name) More...
StreamInfo &	stream_name (const std::string &the_stream_name)
	Sets the name of the stream. More...
TypeInfo &	type_info ()
	Getter (see setter with the same name) More...
const TypeInfo &	type_info () const
	Sets the type information associated with the stream. More...

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

StreamInfo()

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

disposed() [1/2]

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

inline

Getter (see setter with the same name)

Referenced by disposed().

disposed() [2/2]

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.

References disposed().

stream_name() [1/2]

std::string rti::routing::StreamInfo::stream_name ( ) const

inline

Getter (see setter with the same name)

Referenced by stream_name(), and StreamInfo().

stream_name() [2/2]

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().

type_info() [1/2]

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

inline

Getter (see setter with the same name)

References type_info().

Referenced by StreamInfo(), and type_info().

type_info() [2/2]

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

inline

Sets the type information associated with the stream.

See also

TypeInfo.

References type_info().