IT_Reflect::Union Class Reference

#include <it_bus/reflect/union.h>

Inheritance diagram for IT_Reflect::Union:

IT_Reflect::SimpleType IT_Reflect::Reflection IT_Bus::RefCountedBase IT_Reflect::UnionImpl List of all members.

Detailed Description

Reflection of a union simple type.

Definition at line 14 of file union.h.

Public Member Functions

 Union () throw (())
 Constructor.
virtual ~Union () throw (())
 Destructor.
virtual size_t get_member_count () const=0 throw ((ReflectException))
 Returns the number of members defined in the union.
virtual const IT_Bus::QNameget_member_type (size_t index) const=0 throw ((ReflectException))
 Returns the QName of the member at the specified index.
virtual size_t get_selected_member_index () const=0 throw ((ReflectException))
 Returns the index of the selected member.
virtual const Reflectionget_selected_member () const=0 throw ((ReflectException))
 Returns a read-only reflection object of the selected member.
virtual Reflectionuse_member (size_t index)=0 throw ((ReflectException))
 Returns a reflection object of the member at the specified index that can be used to modify the member.
virtual void set_no_member ()=0 throw ((ReflectException))
 Set the union so that no members are selected.


Member Function Documentation

virtual size_t IT_Reflect::Union::get_member_count (  )  const throw ((ReflectException)) [pure virtual]

Returns the number of members defined in the union.

Returns:
the number of members in the union
Exceptions:
ReflectException 

Implemented in IT_Reflect::UnionImpl.

virtual const IT_Bus::QName& IT_Reflect::Union::get_member_type ( size_t  index  )  const throw ((ReflectException)) [pure virtual]

Returns the QName of the member at the specified index.

Parameters:
index the member index
Returns:
the QName of the member at the specified index
Exceptions:
ReflectException If the index is out of bounds

Implemented in IT_Reflect::UnionImpl.

virtual size_t IT_Reflect::Union::get_selected_member_index (  )  const throw ((ReflectException)) [pure virtual]

Returns the index of the selected member.

Returns:
the index of the selected member
Exceptions:
ReflectException If no member is selected

virtual const Reflection* IT_Reflect::Union::get_selected_member (  )  const throw ((ReflectException)) [pure virtual]

Returns a read-only reflection object of the selected member.

Returns:
a read-only Reflection of the selected member. Caller must call _remove_ref().
Exceptions:
ReflectException If no member is selected

virtual Reflection* IT_Reflect::Union::use_member ( size_t  index  )  throw ((ReflectException)) [pure virtual]

Returns a reflection object of the member at the specified index that can be used to modify the member.

The member is selected if necessary.

Parameters:
index the member index
Returns:
a modifiable Reflection of the member at the specified index. Caller must call _remove_ref().
Exceptions:
ReflectException If the index is out of bounds

virtual void IT_Reflect::Union::set_no_member (  )  throw ((ReflectException)) [pure virtual]

Set the union so that no members are selected.

Exceptions:
ReflectException 


Generated on Tue Mar 20 15:28:36 2007 for Artix by  doxygen 1.5.1-p1