mirror of
https://github.com/pocoproject/poco.git
synced 2025-05-02 07:31:37 +02:00
95 lines
2.4 KiB
C++
95 lines
2.4 KiB
C++
//
|
|
// Step.h
|
|
//
|
|
// $Id: //poco/Main/Data/include/Poco/Data/Step.h#7 $
|
|
//
|
|
// Library: Data
|
|
// Package: DataCore
|
|
// Module: Step
|
|
//
|
|
// Definition of the Step class.
|
|
//
|
|
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person or organization
|
|
// obtaining a copy of the software and accompanying documentation covered by
|
|
// this license (the "Software") to use, reproduce, display, distribute,
|
|
// execute, and transmit the Software, and to prepare derivative works of the
|
|
// Software, and to permit third-parties to whom the Software is furnished to
|
|
// do so, all subject to the following:
|
|
//
|
|
// The copyright notices in the Software and this entire statement, including
|
|
// the above license grant, this restriction and the following disclaimer,
|
|
// must be included in all copies of the Software, in whole or in part, and
|
|
// all derivative works of the Software, unless such copies or derivative
|
|
// works are solely in the form of machine-executable object code generated by
|
|
// a source language processor.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
|
|
#ifndef Data_Step_INCLUDED
|
|
#define Data_Step_INCLUDED
|
|
|
|
|
|
#include "Poco/Data/Data.h"
|
|
|
|
|
|
namespace Poco {
|
|
namespace Data {
|
|
|
|
|
|
class Data_API Step
|
|
/// Step stores information how many rows should be returned at evry advance through the recordset.
|
|
{
|
|
public:
|
|
enum
|
|
{
|
|
DEFAULT_STEP = 1u
|
|
};
|
|
|
|
Step(Poco::UInt32 value = 1u);
|
|
/// Creates the Step.
|
|
///
|
|
/// Value contains the step and defaults to DEFAULT_STEP.
|
|
|
|
~Step();
|
|
/// Destroys the Step.
|
|
|
|
Poco::UInt32 value() const;
|
|
/// Returns the value of the limit
|
|
|
|
private:
|
|
Poco::UInt32 _value;
|
|
};
|
|
|
|
|
|
//
|
|
// inlines
|
|
//
|
|
inline Poco::UInt32 Step::value() const
|
|
{
|
|
return _value;
|
|
}
|
|
|
|
|
|
template <typename T>
|
|
Step step(T step)
|
|
{
|
|
return Step(static_cast<Poco::UInt32>(step));
|
|
}
|
|
|
|
|
|
} } // namespace Poco::Data
|
|
|
|
|
|
#endif // Data_Step_INCLUDED
|