Class TPckgBuf

class TPckgBuf : public TAlignedBuf8< sizeof(T)>;

Description

Packages an object into a modifiable buffer descriptor.

The template parameter defines the type of object to be packaged.

The package provides a type safe way of transferring an object or data structure which is contained within a modifiable buffer descriptor. Typically, a package is used for passing data via inter thread communication.

The contained object is accessible through the package.

Derivation

• TAlignedBuf8< sizeof(T)> - No description.

• TPckgBuf - Packages an object into a modifiable buffer descriptor.

Members

Defined in TPckgBuf:

• TPckgBuf()Constructs a packaged modifiable buffer descriptor for an object whose type is d...
• TPckgBuf(const T &)Constructs a packaged modifiable buffer descriptor for an object whose type is d...
• operator()()Gets a reference to the object contained by this packaged modifiable buffer desc...
• operator()()constGets a const reference to the object contained by this packaged modifiable buffe...
• operator=(const T &)Copies data from the specified object into this packaged modifiable buffer descr...
• operator=(const TPckgBuf< T > &)Copies data from the specified packaged modifiable buffer descriptor into this p...

inline TPckgBuf();

Description

Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter.

The length of the packaged descriptor is set to the length of the templated class but no data is assigned into the descriptor.

inline TPckgBuf(const T &aRef);

Description

Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter and copies the supplied object into the descriptor.

The length of the packaged descriptor is set to the length of the templated class.

Parameters

const T &aRef The source object to be copied into the packaged modifiable buffer descriptor.

inline TPckgBuf& operator=(const TPckgBuf< T > &aRef);

Description

Copies data from the specified packaged modifiable buffer descriptor into this packaged modifiable buffer descriptor, replacing any existing data.

Parameters

const TPckgBuf< T > &aRef The source packaged modifiable buffer descriptor.

Return value

TPckgBuf & A reference to this packaged modifiable descriptor.

inline T& operator=(const T &aRef);

Description

Copies data from the specified object into this packaged modifiable buffer descriptor, replacing any existing data.

Parameters

const T &aRef The source object.

Return value

T & A reference to the copy of the source object in the packaged modifiable buffer descriptor.

inline T& operator()();

Description

Gets a reference to the object contained by this packaged modifiable buffer descriptor.

Return value

T & The packaged object.

inline const T& operator()() const;

Description

Gets a const reference to the object contained by this packaged modifiable buffer descriptor.

Return value

const T & The (const) packaged object.