client-cpp  0.0.1-SNAPSHOT
Public Types | Public Member Functions | List of all members
kaa::IDeltaType Class Referenceabstract

#include <IDeltaType.hpp>

+ Inheritance diagram for kaa::IDeltaType:

Public Types

typedef boost::any DeltaValue
 
typedef std::list< DeltaValue > AddedItems
 
typedef std::list< DeltaHandlerId > RemovedItems
 

Public Member Functions

virtual bool isDefault ()=0
 
virtual bool isReset ()=0
 
virtual const DeltaValue & getNewValue ()=0
 
virtual const RemovedItems & getRemovedItems ()=0
 
virtual const AddedItems & getAddedItems ()=0
 
virtual std::string toString () const =0
 
virtual ~IDeltaType ()
 

Detailed Description

Interface of delta type object

Definition at line 34 of file IDeltaType.hpp.

Member Typedef Documentation

typedef std::list<DeltaValue> kaa::IDeltaType::AddedItems

Definition at line 37 of file IDeltaType.hpp.

typedef boost::any kaa::IDeltaType::DeltaValue

Definition at line 36 of file IDeltaType.hpp.

typedef std::list<DeltaHandlerId> kaa::IDeltaType::RemovedItems

Definition at line 38 of file IDeltaType.hpp.

Constructor & Destructor Documentation

virtual kaa::IDeltaType::~IDeltaType ( )
inlinevirtual

Definition at line 88 of file IDeltaType.hpp.

Member Function Documentation

virtual const AddedItems& kaa::IDeltaType::getAddedItems ( )
pure virtual

Retrieves list of added items

Returns
list of added items (IConfigurationDelta for complex items, IDeltaType for others), empty list if there is no added items (or field is not array)

Implemented in kaa::EmptyDeltaType, and kaa::AddedItemsDeltaType.

virtual const DeltaValue& kaa::IDeltaType::getNewValue ( )
pure virtual

Retrieves new field value

Returns
IDeltaValue with specific type or empty one if there is no new value (or field is array)

Implemented in kaa::EmptyDeltaType, and kaa::ValueDeltaType.

virtual const RemovedItems& kaa::IDeltaType::getRemovedItems ( )
pure virtual

Retrieves list of removed editable items

Returns
list which contains handlers DeltaHandlerId of removed items, list is empty if there is no removed items (or field is not array)

Implemented in kaa::EmptyDeltaType, and kaa::RemovedItemsDeltaType.

virtual bool kaa::IDeltaType::isDefault ( )
pure virtual

Checks if the field was set to default value

Returns
true if the field set to default, false otherwise

Implemented in kaa::EmptyDeltaType, and kaa::DefaultDeltaType.

virtual bool kaa::IDeltaType::isReset ( )
pure virtual

Checks if the container field was cleared

Returns
true if the container field is cleared, false if not (or field is not array)

Implemented in kaa::EmptyDeltaType, and kaa::ResetDeltaType.

virtual std::string kaa::IDeltaType::toString ( ) const
pure virtual

Retrieves JSON representation of the inner data

Returns
String representation

Implemented in kaa::EmptyDeltaType, kaa::AddedItemsDeltaType, kaa::RemovedItemsDeltaType, kaa::ValueDeltaType, kaa::DefaultDeltaType, and kaa::ResetDeltaType.

The documentation for this class was generated from the following file: