SourceXtractor::SourceInterface Class Reference

The SourceInterface is an abstract "source" that has properties attached to it. More...

#include <SourceInterface.h>

Inheritance diagram for SourceXtractor::SourceInterface:

Public Member Functions
virtual	~SourceInterface ()=default
	Destructor.
template<typename PropertyType >
const PropertyType &	getProperty (unsigned int index=0) const
	Convenience template method to call getProperty() with a more user-friendly syntax.
template<typename PropertyType , typename ... Args>
void	setIndexedProperty (std::size_t index, Args... args)
	Convenience template method to call setProperty() with a more user-friendly syntax.
template<typename PropertyType , typename ... Args>
void	setProperty (Args... args)
virtual const Property &	getProperty (const PropertyId &property_id) const =0
virtual void	setProperty (std::unique_ptr< Property > property, const PropertyId &property_id)=0

Detailed Description

The SourceInterface is an abstract "source" that has properties attached to it.

Properties are accessed through the templated method getProperty<>()/setProperty<>().

Actual implementation in sub-classed is done by overriding the virtual getProperty()/setProperty()

Definition at line 46 of file SourceInterface.h.

Constructor & Destructor Documentation

~SourceInterface()

virtual SourceXtractor::SourceInterface::~SourceInterface ( )

virtualdefault

Destructor.

Member Function Documentation

getProperty() [1/2]

virtual const Property & SourceXtractor::SourceInterface::getProperty ( const PropertyId & property_id ) const

pure virtual

Returns a reference to the requested property. The property may be computed if needed Throws a PropertyNotFoundException if the property cannot be provided.

Implemented in SourceXtractor::SimpleSource, SourceXtractor::SimpleSourceGroup, SourceXtractor::SourceGroupInterface::SourceWrapper, SourceXtractor::SourceGroupWithOnDemandProperties, SourceXtractor::SourceGroupWithOnDemandProperties::EntangledSource, SourceXtractor::SourceWithOnDemandProperties, SourceXtractor::SimpleSource, SourceXtractor::SimpleSourceGroup, SourceXtractor::SourceGroupInterface::SourceWrapper, SourceXtractor::SourceGroupInterface, SourceXtractor::SourceGroupWithOnDemandProperties, and SourceXtractor::SourceWithOnDemandProperties.

getProperty() [2/2]

template<typename PropertyType >

const PropertyType & SourceXtractor::SourceInterface::getProperty ( unsigned int index = 0 ) const

inline

Convenience template method to call getProperty() with a more user-friendly syntax.

Definition at line 57 of file SourceInterface.h.

References getProperty().

Referenced by getProperty().

Here is the call graph for this function:

setIndexedProperty()

template<typename PropertyType , typename ... Args>

void SourceXtractor::SourceInterface::setIndexedProperty ( std::size_t index, Args... args )

inline

Convenience template method to call setProperty() with a more user-friendly syntax.

Definition at line 64 of file SourceInterface.h.

References setProperty().

Here is the call graph for this function:

setProperty() [1/2]

template<typename PropertyType , typename ... Args>

void SourceXtractor::SourceInterface::setProperty ( Args... args )

inline

Definition at line 72 of file SourceInterface.h.

Referenced by setIndexedProperty().

setProperty() [2/2]

virtual void SourceXtractor::SourceInterface::setProperty ( std::unique_ptr< Property > property, const PropertyId & property_id )

pure virtual

Implemented in SourceXtractor::SimpleSource, SourceXtractor::SimpleSourceGroup, SourceXtractor::SourceGroupInterface::SourceWrapper, SourceXtractor::SourceGroupWithOnDemandProperties, SourceXtractor::SourceGroupWithOnDemandProperties::EntangledSource, SourceXtractor::SourceWithOnDemandProperties, SourceXtractor::SimpleSource, SourceXtractor::SimpleSourceGroup, SourceXtractor::SourceGroupInterface::SourceWrapper, SourceXtractor::SourceGroupInterface, SourceXtractor::SourceGroupWithOnDemandProperties, and SourceXtractor::SourceWithOnDemandProperties.

---

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

• SEFramework/SEFramework/Source/SourceInterface.h