stromx::runtime::String Class Reference

String data value. More...

#include <String.h>

Inheritance diagram for stromx::runtime::String:

Public Member Functions
	String ()
	String (const std::string &value)
	String (const char *value)
virtual const std::string &	type () const
virtual const Version &	version () const
virtual const std::string &	package () const
virtual const VariantHandle &	variant () const
virtual Data *	clone () const
virtual void	serialize (OutputProvider &out) const
virtual void	deserialize (InputProvider &in, const Version &version)
const std::string &	get () const
	operator std::string () const
Public Member Functions inherited from stromx::runtime::DataInterface
bool	isVariant (const VariantInterface &v) const

Friends
STROMX_RUNTIME_API bool	operator== (const String &lhs, const String &rhs)
STROMX_RUNTIME_API bool	operator!= (const String &lhs, const String &rhs)
STROMX_RUNTIME_API std::ostream &	operator<< (std::ostream &out, const String &string)

Detailed Description

String data value.

Constructor & Destructor Documentation

String() [1/3]

stromx::runtime::String::String ( )

inlineexplicit

Constructs an empty string.

String() [2/3]

stromx::runtime::String::String ( const std::string &  value )

inlineexplicit

Constructs a string and initializes it with value.

String() [3/3]

stromx::runtime::String::String ( const char *  value )

inlineexplicit

Constructs a string and initializes it with value.

Member Function Documentation

clone()

virtual Data* stromx::runtime::String::clone ( ) const

inlinevirtual

Returns a copy of the data object, i.e. a object of the same type is allocated and the data of the original object is copied to the new object. A pointer to the new object is returned.

Implements stromx::runtime::DataInterface.

deserialize()

void stromx::runtime::String::deserialize ( InputProvider &  in, const Version &  version  )

virtual

Deserializes a data object.

Parameters

out	The input which the data obtained from.
version	The version of the data class which serialized the input.

Reimplemented from stromx::runtime::Data.

get()

const std::string& stromx::runtime::String::get ( ) const

inline

Returns the value of the string.

operator std::string()

stromx::runtime::String::operator std::string ( ) const

inline

Returns the value of the string.

package()

virtual const std::string& stromx::runtime::String::package ( ) const

inlinevirtual

Returns the package of the class of this data object.

Implements stromx::runtime::DataInterface.

serialize()

void stromx::runtime::String::serialize ( OutputProvider &  out ) const

virtual

Serializes this data object.

Parameters

out	The output which the data is sent to.

Reimplemented from stromx::runtime::Data.

type()

virtual const std::string& stromx::runtime::String::type ( ) const

inlinevirtual

Returns the name of the class of this data object.

Implements stromx::runtime::DataInterface.

variant()

const VariantHandle & stromx::runtime::String::variant ( ) const

virtual

Returns the data variant of this data object.

Implements stromx::runtime::DataInterface.

version()

virtual const Version& stromx::runtime::String::version ( ) const

inlinevirtual

Returns the version of the class of this data object.

Implements stromx::runtime::DataInterface.

Friends And Related Function Documentation

operator!=

STROMX_RUNTIME_API bool operator!= ( const String &  lhs, const String &  rhs  )

friend

Returns true if the contents of lhs and rhs are different.

operator==

STROMX_RUNTIME_API bool operator== ( const String &  lhs, const String &  rhs  )

friend

Returns true if the contents of lhs and rhs are the same.

---

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

• stromx/runtime/String.h
• stromx/runtime/String.cpp