ADTF
Loading...
Searching...
No Matches
Public Member Functions | List of all members
adtf::base::ant::IProperty Class Referenceabstract

#include <property_intf.h>

Inherited by adtf::base::ant::cPropertyBase, and adtf::base::spider::cProperty.

Public Member Functions

virtual const IPropertyValue * GetValue () const =0
 
virtual IPropertyValue * GetValue ()=0
 
virtual tResult SetValue (const IPropertyValue &oValue)=0
 
virtual tResult GetName (IString &&strName) const =0
 
virtual tResult SetName (const IString &strName)=0
 
virtual tResult Set (const IProperty &oProp)=0
 
virtual bool HasProperties () const =0
 
virtual bool HasAttachedProperties () const =0
 
virtual tResult SetProperties (const IProperties &pProperties)=0
 will copy given properties
 
virtual tResult AttachProperties (const ucom::ant::iobject_ptr< IProperties > &pProperties)=0
 
virtual tResult GetAttachedProperties (IProperty &pProperty) const =0
 
virtual tResult DetachProperties ()=0
 
virtual tResult GetProperties (ucom::ant::iobject_ptr< IProperties > &pSubProperties)=0
 get subproperties for writing access
 
virtual tResult GetProperties (ucom::ant::iobject_ptr< const IProperties > &pProperties) const =0
 get subproperties for readonly access
 

Detailed Description

The IProperty interface provides methods for getting and setting property values, name of the property and its subproperties.

Remarks
Since ADTF supports User Defined properties property operation are always COPY operations!

Member Function Documentation

◆ AttachProperties()

virtual tResult adtf::base::ant::IProperty::AttachProperties ( const ucom::ant::iobject_ptr< IProperties > & pProperties)
pure virtual
Deprecated
Attachments are deprecated, they suffer from issues with observers.

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

◆ DetachProperties()

virtual tResult adtf::base::ant::IProperty::DetachProperties ( )
pure virtual
Deprecated
Attachments are deprecated, they suffer from issues with observers.

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

◆ GetAttachedProperties()

virtual tResult adtf::base::ant::IProperty::GetAttachedProperties ( IProperty & pProperty) const
pure virtual
Deprecated
Attachments are deprecated, they suffer from issues with observers.

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

◆ GetProperties() [1/2]

virtual tResult adtf::base::ant::IProperty::GetProperties ( ucom::ant::iobject_ptr< const IProperties > & pProperties) const
pure virtual

get subproperties for readonly access

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

◆ GetProperties() [2/2]

virtual tResult adtf::base::ant::IProperty::GetProperties ( ucom::ant::iobject_ptr< IProperties > & pSubProperties)
pure virtual

get subproperties for writing access

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

◆ SetProperties()

virtual tResult adtf::base::ant::IProperty::SetProperties ( const IProperties & pProperties)
pure virtual

will copy given properties

Implemented in adtf::base::ant::cPropertyBase, adtf::base::cProperty, and adtf::base::spider::cProperty.

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