ADTF
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
adtf::ucom::ant::iobject_enum< INTERFACE_TYPE > Class Template Referenceabstract

#include <object_list.h>

Inherited by adtf::ucom::ant::object_enum_base< T, INTERFACE_TYPE, CONTAINER >.

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
 
virtual tResult GetObjects (my_type &oObjectsEnum) const =0
 
virtual size_t GetSize () const =0
 

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).

Member Function Documentation

◆ GetObjects()

template<typename INTERFACE_TYPE>
virtual tResult adtf::ucom::ant::iobject_enum< INTERFACE_TYPE >::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()

template<typename INTERFACE_TYPE>
virtual size_t adtf::ucom::ant::iobject_enum< INTERFACE_TYPE >::GetSize ( ) const
pure virtual

Retrieves the current value count.

Returns
value count of the container.

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

◆ PushObject()

template<typename INTERFACE_TYPE>
virtual tResult adtf::ucom::ant::iobject_enum< INTERFACE_TYPE >::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
The documentation for this class was generated from the following file: