ai::BaseDataFilter Class Reference

Inheritance diagram for ai::BaseDataFilter:

List of all members.

Public Member Functions
	BaseDataFilter (Mode mode=IDataFilter::Mode::kRead)
AIDataFilter *	GetFirstFilter () const AINOEXCEPT override
	Returns the first filter in this chain, don't use it in a normal case.
AIDataFilter *	GetFilter () const AINOEXCEPT override
	Returns the effective AIDataFilter, use it to pass to various SDK APIs which requires AIDataFilter.
AIDataFilter *	ReleaseFilter () AINOEXCEPT override
	Releases and returns the effective AIDataFilter without unlinking the filter.
ai::LiteralString	GetAIMode () const AINOEXCEPT override
	Returns filter mode to be passed on to AIDataFilter APIs.
Mode	GetMode () const AINOEXCEPT override
	Returns the filter mode enum value.
void	Read (char *store, size_t &count) override
	AIDataFilterSuite::ReadDataFilter
void	Write (const char *store, size_t count) override
	AIDataFilterSuite::WriteDataFilter
void	Seek (sizediff_t newPos) override
	AIDataFilterSuite::SeekDataFilter
sizediff_t	Mark () const override
	AIDataFilterSuite::MarkDataFilter
void	Link (std::unique_ptr< IDataFilter > nextFilter) override
ContentType	ReadFilterContent () override
	Returns the entire content of the filter.
size_t	ContentSize () override
	Returns the size of the content in bytes.
virtual	~BaseDataFilter ()=0
	BaseDataFilter (BaseDataFilter &&other) AINOEXCEPT
BaseDataFilter &	operator= (BaseDataFilter &&other) AINOEXCEPT
void	swap (BaseDataFilter &other) AINOEXCEPT
	BaseDataFilter (BaseDataFilter &other)
BaseDataFilter &	operator= (const BaseDataFilter &other)
Protected Attributes
AIDataFilter *	mFilter = nullptr
AIErrorThrower	mError = kNoErr
Mode	mMode = Mode::kRead
std::unique_ptr< IDataFilter >	mNextFilter

---

Constructor & Destructor Documentation

ai::BaseDataFilter::BaseDataFilter

(

Mode

mode = IDataFilter::Mode::kRead

)

[inline, explicit]

ai::BaseDataFilter::~BaseDataFilter

(

)

[pure virtual]

References AIMsgAssert, mError, mFilter, mNextFilter, and AIDataFilterSuite::UnlinkDataFilter.

ai::BaseDataFilter::BaseDataFilter

(

BaseDataFilter &&

other

)

[inline]

References swap().

ai::BaseDataFilter::BaseDataFilter

(

BaseDataFilter &

other

)

---

Member Function Documentation

size_t ai::BaseDataFilter::ContentSize

(

)

[override, virtual]

Returns the size of the content in bytes.

The size gets computed with forward and backward seeking. Not all DataFilter support seeking.

Implements ai::IDataFilter.

References Mark(), and Seek().

ai::LiteralString ai::BaseDataFilter::GetAIMode

(

)

const [override, virtual]

Returns filter mode to be passed on to AIDataFilter APIs.

Implements ai::IDataFilter.

References AIMsgAssert, and mMode.

Referenced by ai::A85DataFilter::A85DataFilter(), ai::AsyncDataFilter::AsyncDataFilter(), ai::FileDataFilter::FileDataFilter(), ai::ZDataFilter::ZDataFilter(), and ai::ZStdDataFilter::ZStdDataFilter().

AIDataFilter* ai::BaseDataFilter::GetFilter

(

)

const [inline, override, virtual]

Returns the effective AIDataFilter, use it to pass to various SDK APIs which requires AIDataFilter.

Implements ai::IDataFilter.

References mFilter, and mNextFilter.

Referenced by Link(), Mark(), Read(), Seek(), and Write().

AIDataFilter* ai::BaseDataFilter::GetFirstFilter

(

)

const [inline, override, virtual]

Returns the first filter in this chain, don't use it in a normal case.

It is used to chain two filter chains together

Implements ai::IDataFilter.

References mFilter.

Mode ai::BaseDataFilter::GetMode

(

)

const [inline, override, virtual]

Returns the filter mode enum value.

Implements ai::IDataFilter.

References mMode.

void ai::BaseDataFilter::Link

(

std::unique_ptr< IDataFilter >

nextFilter

)

[override]

References GetFilter(), AIDataFilterSuite::LinkDataFilter, mError, and mNextFilter.

ai::sizediff_t ai::BaseDataFilter::Mark

(

)

const [override, virtual]

AIDataFilterSuite::MarkDataFilter

Implements ai::IDataFilter.

References GetFilter(), AIDataFilterSuite::MarkDataFilter, and mError.

Referenced by ContentSize().

BaseDataFilter& ai::BaseDataFilter::operator=

(

const BaseDataFilter &

other

)

BaseDataFilter& ai::BaseDataFilter::operator=

(

BaseDataFilter &&

other

)

[inline]

References swap().

void ai::BaseDataFilter::Read	(	char *	store,
		size_t &	count
	)			[override, virtual]

AIDataFilterSuite::ReadDataFilter

Implements ai::IDataFilter.

References GetFilter(), ai::IDataFilter::kInvalidFilterModeError, mError, mMode, and AIDataFilterSuite::ReadDataFilter.

Referenced by ReadFilterContent().

ai::IDataFilter::ContentType ai::BaseDataFilter::ReadFilterContent

(

)

[override, virtual]

Returns the entire content of the filter.

Use it only for small files. When the entire content of the filter can be read in a continuous dynamic memory.

Implements ai::IDataFilter.

References Read(), and Seek().

AIDataFilter* ai::BaseDataFilter::ReleaseFilter

(

)

[inline, override, virtual]

Releases and returns the effective AIDataFilter without unlinking the filter.

This should only be used when the AIDataFilter is owned by another IDataFilter.

Implements ai::IDataFilter.

References mFilter.

void ai::BaseDataFilter::Seek

(

sizediff_t

newPos

)

[override, virtual]

AIDataFilterSuite::SeekDataFilter

Implements ai::IDataFilter.

References GetFilter(), mError, and AIDataFilterSuite::SeekDataFilter.

Referenced by ContentSize(), and ReadFilterContent().

void ai::BaseDataFilter::swap

(

BaseDataFilter &

other

)

Referenced by BaseDataFilter(), and operator=().

void ai::BaseDataFilter::Write	(	const char *	store,
		size_t	count
	)			[override, virtual]

AIDataFilterSuite::WriteDataFilter

Implements ai::IDataFilter.

References GetFilter(), ai::IDataFilter::kInvalidFilterModeError, mError, mMode, and AIDataFilterSuite::WriteDataFilter.

---

Member Data Documentation

AIErrorThrower ai::BaseDataFilter::mError = kNoErr [mutable, protected]

Referenced by ai::A85DataFilter::A85DataFilter(), ai::AsyncDataFilter::AsyncDataFilter(), ai::BlockDataFilter::BlockDataFilter(), ai::BufferDataFilter::BufferDataFilter(), ai::FileDataFilter::FileDataFilter(), Link(), Mark(), Read(), ai::ResourceDataFilter::ResourceDataFilter(), ai::ScopedDataFilter::ScopedDataFilter(), Seek(), ai::VMDataFilter::VMDataFilter(), Write(), ai::ZDataFilter::ZDataFilter(), ai::ZStdDataFilter::ZStdDataFilter(), and ~BaseDataFilter().

AIDataFilter* ai::BaseDataFilter::mFilter = nullptr [protected]

Referenced by ai::A85DataFilter::A85DataFilter(), ai::AsyncDataFilter::AsyncDataFilter(), ai::BlockDataFilter::BlockDataFilter(), ai::BufferDataFilter::BufferDataFilter(), ai::FileDataFilter::FileDataFilter(), GetFilter(), GetFirstFilter(), ReleaseFilter(), ai::ResourceDataFilter::ResourceDataFilter(), ai::ScopedDataFilter::ScopedDataFilter(), ai::VMDataFilter::VMDataFilter(), ai::ZDataFilter::ZDataFilter(), ai::ZStdDataFilter::ZStdDataFilter(), and ~BaseDataFilter().

Mode ai::BaseDataFilter::mMode = Mode::kRead [protected]

Referenced by GetAIMode(), GetMode(), Read(), and Write().

std::unique_ptr<IDataFilter> ai::BaseDataFilter::mNextFilter [protected]

Referenced by GetFilter(), Link(), and ~BaseDataFilter().

---

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

• IAIDataFilter.cpp