An object that allows read access to data of a channel. More...

#include <fw/ChannelReadWrite.h>

Inheritance diagram for ChannelRead< T >:

Public Types
typedef Base::Slot	Slot

typedef boost::shared_ptr< Shared >	SharedPtr

typedef Shared::ChannelType	ChannelType

Public Member Functions
	ChannelRead ()
	Default constructor that constructs a ChannelRead object that is invalid at the beginning and contains no data. More...

	ChannelRead (ChannelTypePtr channel, ChannelBufferBase::Slot *slot)
	Is called by Channel to construct a ChannelRead object. More...

	operator const ValueType & () const
	Allows to cast Reading Data from Channels and Writing to Channels easily into a const reference of the wrapped data type. More...

const ValueType &	operator* () const
	Returns a const reference on the data. More...

const ValueType *	operator-> () const
	Returns a const pointer on the data. More...

const Buffer< uint8 > &	readSerializedValue ()

const Buffer< uint8 > &	readSerializedValue (uint8 formatVersion, bool orLower)

Buffer< uint8 >	readSerializedValue (std::list< BinarySerializerCodecPtr > &codecs)

Buffer< uint8 >	readSerializedValue (std::list< BinarySerializerCodecPtr > &codecs, uint8 formatVersion, bool orLower)

void	readJSON (JSONValue &oValue)

void	readJSON (JSONValue &oValue, JSONSerializer &serializer)

void	finish ()
	Releases the lock explicitly. More...

Channel< T >	getChannel ()
	Returns a read-only channel proxy object of the underlying channel. More...

bool	isValid () const
	Returns true, if data was assigned to the ChannelRead or ChannelWrite and if this data is locked. More...

const std::string &	getChannelID ()

std::string	getTypename () const

TypeMetaPtr	getTypeMeta () const

const Time &	getTimestamp () const

int	getUseCount () const
	Returns the number of shared instances for this data, may be useful for debugging purposes. More...

uint32	getFlags () const
	For internal use only. More...

void	addFlags (uint32 moreFlags) const
	For internal use only. More...

Protected Types
typedef ChannelReadWriteBase< ChannelRead< T >, T >	Base

typedef Base::Shared	Shared

typedef Base::ChannelTypePtr	ChannelTypePtr

typedef Base::ValueType	ValueType

Protected Member Functions
ValueType &	internalValue ()
	Returns a reference on the data. More...

const ValueType &	internalValue () const
	Returns a const reference on the data. More...

void	checkValid () const
	checks if we are still locked, if not it throws a XAccessViolation More...

void	writeSerializedValue (Buffer< uint8 > data)

void	writeJSON (const JSONValue &value)

void	writeJSON (JSONDeserializer &deserializer)

void	writeXML (const XMLDom::const_iterator &node)

Static Protected Member Functions
static void	finish (Shared *shared)

static void	discard (Shared *shared)

Protected Attributes
SharedPtr	shared

Friends
class	ChannelReadWriteShared< ChannelRead< T > >

Detailed Description

template<typename T>
class mira::ChannelRead< T >

An object that allows read access to data of a channel.

Use Channel::read to obtain access to data of a channel.

The ChannelRead automatically take care that the data is unlocked if the ChannelRead object is no longer used and went out of scope. To explicitly release the data by calling the finish() method.

You can freely copy and reassign the ChannelRead object to other ChannelRead variables. The ChannelRead contains an internal reference counting mechanism. The lock is freed only after all copies have been destroyed or one copy called the finish() method.

Examples:: tutorials/MeanCalculator.C, tutorials/MeanCalculatorWithProperties.C, tutorials/Point2Visualization.C, tutorials/Point3BasicVisualization.C, and tutorials/Point3Visualization.C.

Member Typedef Documentation

◆ Base

typedef ChannelReadWriteBase<ChannelRead<T>,T> Base

protected

◆ Shared

typedef Base::Shared Shared

protected

◆ ChannelTypePtr

typedef Base::ChannelTypePtr ChannelTypePtr

protected

◆ ValueType

typedef Base::ValueType ValueType

protected

◆ Slot

typedef Base::Slot Slot

inherited

◆ SharedPtr

typedef boost::shared_ptr<Shared> SharedPtr

inherited

◆ ChannelType

typedef Shared::ChannelType ChannelType

inherited

Constructor & Destructor Documentation

◆ ChannelRead() [1/2]

ChannelRead ( )

inline

Default constructor that constructs a ChannelRead object that is invalid at the beginning and contains no data.

Before you can use the object you need to assign a valid ChannelWrite object that was obtained using Channel::read().

You can use the isValid() method to check if a ChannelRead object is valid and contains locked data.

◆ ChannelRead() [2/2]

ChannelRead	(	ChannelTypePtr	channel,
		ChannelBufferBase::Slot *	slot
	)

inline

Is called by Channel to construct a ChannelRead object.

Note: You should never need to use this constructor directly!

Member Function Documentation

◆ operator const ValueType &()

operator const ValueType & ( ) const

inline

Allows to cast Reading Data from Channels and Writing to Channels easily into a const reference of the wrapped data type.

Exceptions

XRuntime,if the lock on the data was lost, e.g. by calling the finish() method.

◆ operator*()

const ValueType& operator* ( ) const

inline

Returns a const reference on the data.

This is essentially the same as calling internalValue() but simplifies the usage similar to STL-iterators.

Exceptions

XRuntime,if the lock on the data was lost, e.g. by calling the finish() method.

◆ operator->()

const ValueType* operator-> ( ) const

inline

Returns a const pointer on the data.

This simplifies the usage similar to STL-iterators:

stuct MyClass {
    void foo();
}
ChannelRead<MyClass> data = ...;
data->foo(); // directly calls foo() of MyClass

Exceptions

XRuntime,if the lock on the data was lost, e.g. by calling the finish() method

◆ readSerializedValue() [1/4]

const Buffer<uint8>& readSerializedValue ( )

inline

◆ readSerializedValue() [2/4]

const Buffer<uint8>& readSerializedValue	(	uint8	formatVersion,
		bool	orLower
	)

inline

◆ readSerializedValue() [3/4]

Buffer<uint8> readSerializedValue ( std::list< BinarySerializerCodecPtr > & codecs )

inline

◆ readSerializedValue() [4/4]

Buffer<uint8> readSerializedValue	(	std::list< BinarySerializerCodecPtr > &	codecs,
		uint8	formatVersion,
		bool	orLower
	)

inline

◆ readJSON() [1/2]

void readJSON ( JSONValue & oValue )

inline

◆ readJSON() [2/2]

void readJSON	(	JSONValue &	oValue,
		JSONSerializer &	serializer
	)

inline

◆ finish() [1/2]

void finish ( )

inline

Releases the lock explicitly.

Note: After calling this method accessing the data results in an XRuntime exception.

◆ getChannel()

Channel<T> getChannel ( )

Returns a read-only channel proxy object of the underlying channel.

◆ finish() [2/2]

static void finish ( Shared * shared )

inlinestaticprotected

◆ discard()

static void discard ( Shared * shared )

inlinestaticprotected

◆ internalValue() [1/2]

ValueType& internalValue ( )

inlineprotectedinherited

Returns a reference on the data.

Exceptions

Throws XRuntime, if the lock on the data was lost, e.g. by calling the finish() method

◆ internalValue() [2/2]

const ValueType& internalValue ( ) const

inlineprotectedinherited

Returns a const reference on the data.

Exceptions

Throws XRuntime, if the lock on the data was lost, e.g. by calling the finish() method

◆ isValid()

bool isValid ( ) const

inlineinherited

Returns true, if data was assigned to the ChannelRead or ChannelWrite and if this data is locked.

If this method returns true, you can safely access the underlying data.

If this method returns false, no data was assigned to the ChannelRead / ChannelWrite or the lock on the data was lost. Hence, it is not safe to access the underlying data. If you try to access the data anyway you will get an XRuntime exception.

◆ getChannelID()

const std::string& getChannelID ( )

inlineinherited

◆ getTypename()

std::string getTypename ( ) const

inlineinherited

◆ getTypeMeta()

TypeMetaPtr getTypeMeta ( ) const

inlineinherited

◆ getTimestamp()

const Time& getTimestamp ( ) const

inlineinherited

◆ getUseCount()

int getUseCount ( ) const

inlineinherited

Returns the number of shared instances for this data, may be useful for debugging purposes.

◆ getFlags()

uint32 getFlags ( ) const

inlineinherited

For internal use only.

Used by remote components of the framework and by player and recorder. Returns current flags of this slot;

◆ addFlags()

void addFlags ( uint32 moreFlags ) const

inlineinherited

For internal use only.

Used by remote components of the framework and by player and recorder. Add additional flags to the slots flags.

◆ checkValid()

void checkValid ( ) const

inlineprotectedinherited

checks if we are still locked, if not it throws a XAccessViolation

◆ writeSerializedValue()

void writeSerializedValue ( Buffer< uint8 > data )

inlineprotectedinherited

◆ writeJSON() [1/2]

void writeJSON ( const JSONValue & value )

inlineprotectedinherited

◆ writeJSON() [2/2]

void writeJSON ( JSONDeserializer & deserializer )

inlineprotectedinherited

◆ writeXML()

void writeXML ( const XMLDom::const_iterator & node )

inlineprotectedinherited

Friends And Related Function Documentation

◆ ChannelReadWriteShared< ChannelRead< T > >

friend class ChannelReadWriteShared< ChannelRead< T > >

friend

Member Data Documentation

◆ shared

SharedPtr shared

protectedinherited

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

framework/include/fw/ChannelReadWrite.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<typename T> class mira::ChannelRead< T >

Member Typedef Documentation

◆ Base

◆ Shared

◆ ChannelTypePtr

◆ ValueType

◆ Slot

◆ SharedPtr

◆ ChannelType

Constructor & Destructor Documentation

◆ ChannelRead() [1/2]

◆ ChannelRead() [2/2]

Member Function Documentation

◆ operator const ValueType &()

◆ operator*()

◆ operator->()

◆ readSerializedValue() [1/4]

◆ readSerializedValue() [2/4]

◆ readSerializedValue() [3/4]

◆ readSerializedValue() [4/4]

◆ readJSON() [1/2]

◆ readJSON() [2/2]

◆ finish() [1/2]

◆ getChannel()

◆ finish() [2/2]

◆ discard()

◆ internalValue() [1/2]

◆ internalValue() [2/2]

◆ isValid()

◆ getChannelID()

◆ getTypename()

◆ getTypeMeta()

◆ getTimestamp()

◆ getUseCount()

◆ getFlags()

◆ addFlags()

◆ checkValid()

◆ writeSerializedValue()

◆ writeJSON() [1/2]

◆ writeJSON() [2/2]

◆ writeXML()

Friends And Related Function Documentation

◆ ChannelReadWriteShared< ChannelRead< T > >

Member Data Documentation

◆ shared

template<typename T>
class mira::ChannelRead< T >