lexis::render::Stream Class Reference

Inheritance diagram for lexis::render::Stream:

Collaboration diagram for lexis::render::Stream:

Public Types
typedef ::zerobuf::Vector< char >	Host
typedef ::zerobuf::Vector< char >	Id

Public Member Functions
Stream::Host &	getHost ()
	Get a reference to the Host dynamic member. More...
const Stream::Host &	getHost () const
void	setHost (char const *value, size_t size)
	Set the value of the Host dynamic object from a char* and size. More...
std::string	getHostString () const
void	setHost (const std::string &value)
	Set the value of the Host dynamic object from a std::string. More...
Stream::Id &	getId ()
	Get a reference to the Id dynamic member. More...
const Stream::Id &	getId () const
void	setId (char const *value, size_t size)
	Set the value of the Id dynamic object from a char* and size. More...
std::string	getIdString () const
void	setId (const std::string &value)
	Set the value of the Id dynamic object from a std::string. More...
bool	getEnabled () const
void	setEnabled (bool value)
	Set the Enabled value. More...
uint16_t	getPort () const
void	setPort (uint16_t value)
	Set the Port value. More...
bool	getCompression () const
void	setCompression (bool value)
	Set the Compression value. More...
uint16_t	getQuality () const
void	setQuality (uint16_t value)
	Set the Quality value. More...
void	compact (float threshold=0.1f) final
	Stream (const std::string &hostValue, const bool &enabledValue, const std::string &idValue, const uint16_t &portValue, const bool &compressionValue, const uint16_t &qualityValue)
	Stream (const Stream &rhs)
	Stream (Stream &&rhs) noexcept
	Stream (const ::zerobuf::Zerobuf &rhs)
	Stream (::zerobuf::AllocatorPtr allocator)
Stream &	operator= (const Stream &rhs)
Stream &	operator= (Stream &&rhs)
std::string	getSchema () const final
std::string	getTypeName () const final
::zerobuf::uint128_t	getTypeIdentifier () const final
size_t	getZerobufStaticSize () const final
size_t	getZerobufNumDynamics () const final
void	_parseJSON (const Json::Value &json) final
void	_createJSON (Json::Value &json) const final

Static Public Member Functions
static std::string	ZEROBUF_SCHEMA ()
static std::string	ZEROBUF_TYPE_NAME ()
::zerobuf::uint128_t	ZEROBUF_TYPE_IDENTIFIER ()
static size_t	ZEROBUF_STATIC_SIZE ()
static size_t	ZEROBUF_NUM_DYNAMICS ()
static ConstStreamPtr	create (const void *data, const size_t size)

Detailed Description

Definition at line 18 of file stream.h.

Member Function Documentation

Stream::Host& lexis::render::Stream::getHost

(

)

Get a reference to the Host dynamic member.

Warning

: If the reference is used to modify the object, notifyChanged() needs to be explicitly called afterwards.

Returns

a reference to the Host dynamic member.

Stream::Id& lexis::render::Stream::getId

(

)

Get a reference to the Id dynamic member.

Warning

: If the reference is used to modify the object, notifyChanged() needs to be explicitly called afterwards.

Returns

a reference to the Id dynamic member.

void lexis::render::Stream::setCompression

(

bool

value

)

Set the Compression value.

notifyChanged() is internally called after the change has been done.

Parameters

value

the Compression value

void lexis::render::Stream::setEnabled

(

bool

value

)

Set the Enabled value.

notifyChanged() is internally called after the change has been done.

Parameters

value

the Enabled value

void lexis::render::Stream::setHost	(	char const *	value,
		size_t	size
	)

Set the value of the Host dynamic object from a char* and size.

notifyChanged() is internally called after the data has been copied.

Parameters

value	a char* to the data to be set in the current object
size	the size of the data to be set

void lexis::render::Stream::setHost

(

const std::string &

value

)

Set the value of the Host dynamic object from a std::string.

notifyChanged() is internally called after the data has been copied.

Parameters

value

a std::string with the data to be set

void lexis::render::Stream::setId	(	char const *	value,
		size_t	size
	)

Set the value of the Id dynamic object from a char* and size.

notifyChanged() is internally called after the data has been copied.

Parameters

value	a char* to the data to be set in the current object
size	the size of the data to be set

void lexis::render::Stream::setId

(

const std::string &

value

)

Set the value of the Id dynamic object from a std::string.

notifyChanged() is internally called after the data has been copied.

Parameters

value

a std::string with the data to be set

void lexis::render::Stream::setPort

(

uint16_t

value

)

Set the Port value.

notifyChanged() is internally called after the change has been done.

Parameters

value

the Port value

void lexis::render::Stream::setQuality

(

uint16_t

value

)

Set the Quality value.

notifyChanged() is internally called after the change has been done.

Parameters

value

the Quality value

---

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

• stream.h