ADTF  3.15.1
iobject_enum< INTERFACE_TYPE >abstract

Interface definition for a container of objects. More...

Public Types

typedef iobject_ptr< INTERFACE_TYPE > value_type
 value type of the contained objects
 
typedef iobject_enum< INTERFACE_TYPE > my_type
 this type
 

Public Member Functions

virtual tResult PushObject (const value_type &oObject)=0
 Pushes a object of value_type to the container. More...
 
virtual tResult GetObjects (my_type &oObjectsEnum) const =0
 Pushes every contained value to the given container in oObjectsEnum. More...
 
virtual size_t GetSize () const =0
 Retrieves the current value count. More...
 

Protected Member Functions

 ~iobject_enum ()
 hide DTOR
 

Detailed Description

template<typename INTERFACE_TYPE>
class adtf::ucom::ant::iobject_enum< INTERFACE_TYPE >

Interface definition for a container of objects.

Template Parameters
INTERFACE_TYPEtype of the value type (must be derived from IObject).

Definition at line 21 of file object_list.h.

Member Function Documentation

◆ GetObjects()

virtual tResult GetObjects ( my_type oObjectsEnum) const
pure virtual

Pushes every contained value to the given container in oObjectsEnum.

Parameters
[in]oObjectsEnumContainer where to push the objects.
Returns
standard error code

◆ GetSize()

virtual size_t GetSize ( ) const
pure virtual

Retrieves the current value count.

Returns
value count of the container.

Implemented in object_enum_base< T, INTERFACE_TYPE, CONTAINER >, and object_enum_base< T, T, std::list >.

◆ PushObject()

virtual tResult PushObject ( const value_type oObject)
pure virtual

Pushes a object of value_type to the container.

The PushObject implementation may decide if the value is accepted or not.

Parameters
[in]oObjecta object reference of the value
Return values
ERR_INVALID_INTERFACEReturns if the value is not INTERFACE_TYPE

Referenced by adtf::streaming::hollow::get_data_binding_objects(), adtf::streaming::hollow::get_graph_objects(), adtf::streaming::hollow::get_interface_binding_objects(), and adtf::streaming::hollow::get_runner_objects().