ChannelReadWriteBase< Derived, T > Class Template Reference

#include <fw/ChannelReadWrite.h>

Inheritance diagram for ChannelReadWriteBase< Derived, T >:

Public Types
typedef ChannelReadWriteCommonBase< Derived >	Base
typedef Base::Shared	Shared
typedef Base::ChannelTypePtr	ChannelTypePtr
typedef Base::Slot	Slot
typedef Base::ValueType	ValueType
typedef boost::shared_ptr< Shared >	SharedPtr
typedef Shared::ChannelType	ChannelType

Public Member Functions
	ChannelReadWriteBase ()
	Constructs an empty (invalid) ChannelReadWriteBase object. More...
	ChannelReadWriteBase (ChannelTypePtr channel, ChannelBufferBase::Slot *slot)
	Constructs a valid ChannelReadWriteBase object that is assigned to a channel and slot. 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 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...
const Buffer< uint8 > &	readSerializedValue ()
const Buffer< uint8 > &	readSerializedValue (uint8 formatVersion, bool orLower)
Buffer< uint8 >	readSerializedValue (std::list< BinarySerializerCodecPtr > &codecs)
	Same as above, but allows to specify codecs for serialization. More...
Buffer< uint8 >	readSerializedValue (std::list< BinarySerializerCodecPtr > &codecs, uint8 formatVersion, bool orLower)
void	readJSON (JSONValue &oValue)
void	readJSON (JSONValue &oValue, JSONSerializer &serializer)
void	writeSerializedValue (Buffer< uint8 > data)
void	writeJSON (const JSONValue &value)
void	writeJSON (JSONDeserializer &deserializer)
void	writeXML (const XMLDom::const_iterator &node)

Protected Attributes
SharedPtr	shared

Member Typedef Documentation

Base

typedef ChannelReadWriteCommonBase<Derived> Base

Shared

typedef Base::Shared Shared

ChannelTypePtr

typedef Base::ChannelTypePtr ChannelTypePtr

Slot

typedef Base::Slot Slot

ValueType

typedef Base::ValueType ValueType

SharedPtr

typedef boost::shared_ptr<Shared> SharedPtr

inherited

ChannelType

typedef Shared::ChannelType ChannelType

inherited

Constructor & Destructor Documentation

ChannelReadWriteBase() [1/2]

ChannelReadWriteBase ( )

inline

Constructs an empty (invalid) ChannelReadWriteBase object.

ChannelReadWriteBase() [2/2]

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

inline

Constructs a valid ChannelReadWriteBase object that is assigned to a channel and slot.

Member Function Documentation

internalValue() [1/2]

ValueType& internalValue ( )

inlineprotected

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

inlineprotected

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

readSerializedValue() [1/4]

const Buffer<uint8>& readSerializedValue ( )

inlineprotectedinherited

readSerializedValue() [2/4]

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

inlineprotectedinherited

readSerializedValue() [3/4]

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

inlineprotectedinherited

Same as above, but allows to specify codecs for serialization.

readSerializedValue() [4/4]

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

inlineprotectedinherited

readJSON() [1/2]

void readJSON ( JSONValue &  oValue )

inlineprotectedinherited

readJSON() [2/2]

void readJSON ( JSONValue &  oValue, JSONSerializer &  serializer  )

inlineprotectedinherited

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

Member Data Documentation

shared

SharedPtr shared

protectedinherited

---

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

• framework/include/fw/ChannelReadWrite.h