IT_Reflect::ModelGroup Class Reference

#include <it_bus/reflect/model_group.h>

Inheritance diagram for IT_Reflect::ModelGroup:

List of all members.

---

Detailed Description

The model group types are sequence, choice and all.

They all share this common API.

Definition at line 15 of file model_group.h.

Public Member Functions
	ModelGroup () throw (())
	Constructor.
virtual	~ModelGroup () throw (())
	Destructor.
virtual size_t	get_element_count () const =0 throw ((ReflectException))
	Get the number of elements defined in this object's schema.
virtual const IT_Bus::QName &	get_element_name (size_t i) const =0 throw ((ReflectException))
	Get the name of the ith element.
virtual const Reflection *	get_element (size_t i) const =0 throw ((ReflectException))
	Get read-only reflection of the i'th element, that is the element whos name is get_element_names()[i].
virtual const Reflection *	get_element (const IT_Bus::QName &name) const =0 throw ((ReflectException))
	Get read-only reflection of named element.
virtual Reflection *	use_element (size_t i)=0 throw ((ReflectException))
	Use the element at the specified index.
virtual Reflection *	use_element (const IT_Bus::QName &name)=0 throw ((ReflectException))
	Use the named element.

---

Member Function Documentation

virtual const Reflection* IT_Reflect::ModelGroup::get_element (  const IT_Bus::QName &  name  )  const throw ((ReflectException)) [pure virtual]

Get read-only reflection of named element. For a choice, the named element must be current. Parameters: name  Name of element. Returns: Reflection of named element. Caller must _remove_ref(). Exceptions: ReflectException  if name is invalid or this is a choice and named element is not current.

virtual const Reflection* IT_Reflect::ModelGroup::get_element (  size_t  i  )  const throw ((ReflectException)) [pure virtual]

Get read-only reflection of the i'th element, that is the element whos name is get_element_names()[i]. For a choice the i'th element must be the current element. Returns: Reflection of element at the specified index. Caller must _remove_ref() Exceptions: ReflectException  if i is out of bounds, or this is a choice and the i'th element is not current.

virtual size_t IT_Reflect::ModelGroup::get_element_count (   )  const throw ((ReflectException)) [pure virtual]

Get the number of elements defined in this object's schema. Returns: the number of elements in the schema Exceptions: ReflectException  Implemented in IT_Reflect::ModelGroupImpl.

virtual const IT_Bus::QName& IT_Reflect::ModelGroup::get_element_name (  size_t  i  )  const throw ((ReflectException)) [pure virtual]

Get the name of the ith element. Returns: the QName of the element at the specified index Exceptions: ReflectException  Implemented in IT_Reflect::ModelGroupImpl.

virtual Reflection* IT_Reflect::ModelGroup::use_element (  const IT_Bus::QName &  name  )  throw ((ReflectException)) [pure virtual]

Use the named element. Returns a pointer to a reflection object that can be used to modify the element. For a choice this makes the named element current. Parameters: name  of the element. Returns: modifiable reflection of the element. Caller must _remove_ref(). Exceptions: ReflectException  if name is invalid. Implemented in IT_Reflect::ModelGroupImpl.

virtual Reflection* IT_Reflect::ModelGroup::use_element (  size_t  i  )  throw ((ReflectException)) [pure virtual]

Use the element at the specified index. Returns a Reflection object that can be used to modify the element. For a choice, makes the element at i current. Precondition: i must be less than get_element_count() Parameters: index  of element. Returns: modifiable reflection of the element. Caller must _remove_ref(). Exceptions: ReflectException  if i is out of bounds. Implemented in IT_Reflect::ModelGroupImpl.

---