IT_Bus::Part Class Reference

#include <it_bus/part.h>

List of all members.

---

Detailed Description

Class representing a part of a message.

Definition at line 36 of file part.h.

Public Types
enum	AutoDelete
	Enum indicating whether the value associated with the part should be deleted when the part is destroyed. More...
Public Member Functions
	Part () IT_THROW_DECL(())
	Constructor.
	Part (const QName &name, AnyType *value, AutoDelete auto_delete=NO_DELETE) IT_THROW_DECL(())
	Constructor.
	Part (const QName &name, const AnyType *value, AutoDelete auto_delete=NO_DELETE) IT_THROW_DECL(())
	Constructor.
	Part (const Part &other)
	Constructor.
	Part (Part &other, Boolean take_ownership)
	Constructor.
void	operator= (const Part &)
	Assignment Operator.
void	refer (const Part &other)
	Refer to the value in the other part; does not take ownership.
void	take (Part &other)
	Refer to the value in the other part.
void	set_name (const QName &name) IT_THROW_DECL(())
	Set the name of the part.
QName	get_name () const IT_THROW_DECL(())
	Obtain the name of the part.
void	set_const_value (const AnyType *value, AutoDelete auto_delete=NO_DELETE) IT_THROW_DECL(())
	Replace old value with const value.
void	set_modifiable_value (AnyType *value, AutoDelete auto_delete=NO_DELETE) IT_THROW_DECL(())
	Replace old value with modifiable value.
Boolean	is_const () const IT_THROW_DECL(())
	Obtain an indicator of whether this part is a const.
const AnyType &	get_const_value () const IT_THROW_DECL(())
	Get a const pointer to the value associated with the part.
AnyType &	get_modifiable_value () IT_THROW_DECL((NotModifiable))
	Get a non-const pointer to the value associated with the part.
void	set_skip (Boolean)
	Set an indicator of whether the part should be skipped when reading or writing the part value.
Private Attributes
QName	m_name
AnyType *	m_modifiable
const AnyType *	m_const
Boolean	m_skip
AutoDelete	m_auto_delete

---

Member Enumeration Documentation

enum IT_Bus::Part::AutoDelete

Enum indicating whether the value associated with the part should be deleted when the part is destroyed.

Possible values:

 AUTO_DELETE
 NO_DELETE
 

Definition at line 53 of file part.h.

---

Constructor & Destructor Documentation

IT_Bus::Part::Part	(	const QName &	name,
		AnyType *	value,
		AutoDelete	auto_delete = NO_DELETE
	)

Constructor.

Refers to value, value must not be destroyed before this. If auto_delete is true, value will be deleted by the list.

Parameters:

	QName	for the part.
	A	pointer to an IT_Bus::AnyType that is the value to be associated with the part.
	AutoDelete	enum.

IT_Bus::Part::Part	(	const QName &	name,
		const AnyType *	value,
		AutoDelete	auto_delete = NO_DELETE
	)

Constructor.

Refers to const value, value must not be destroyed before this. If auto_delete is true, value will be deleted by the list.

Parameters:

	QName	for the part.
	A	pointer to an IT_Bus::AnyType that is the value to be associated with the part.
	AutoDelete	enum.

IT_Bus::Part::Part

(

const Part &

other

)

Constructor.

Make this part refer to value of another part.

Parameters:

A

reference to another IT_Bus::Part instance.

IT_Bus::Part::Part	(	Part &	other,
		Boolean	take_ownership
	)

Constructor.

If take_ownership is true and the other part owns its value then transfer ownership to the new part, otherwise refer to other's value.

Parameters:

	A	reference to another IT_Bus::Part instance.
	Boolean	indicating whether this instance should take ownership of the value.

---

Member Function Documentation

AnyType& IT_Bus::Part::get_modifiable_value

(

)

Get a non-const pointer to the value associated with the part.

Exceptions:

NotModifiable

if the part is const.

QName IT_Bus::Part::get_name

(

)

const

Obtain the name of the part.

Returns:

QName of this part.

Boolean IT_Bus::Part::is_const

(

)

const

Obtain an indicator of whether this part is a const.

True if this part is const.

void IT_Bus::Part::operator=

(

const Part &

)

Assignment Operator.

Make this part refer to value of another part.

Parameters:

A

reference to another IT_Bus::Part instance.

void IT_Bus::Part::set_name

(

const QName &

name

)

Set the name of the part.

Parameters:

QName

of the part.

void IT_Bus::Part::set_skip

(

Boolean

)

Set an indicator of whether the part should be skipped when reading or writing the part value.

True indicates that the part should be skipped.

void IT_Bus::Part::take

(

Part &

other

)

Refer to the value in the other part.

If other part owns its value, take ownership; otherwise simply refer to the value.

---