VxSdk::VxCollection< T > Struct Template Reference

Represents a collection of resources. More...

#include <VxCollection.h>

Public Member Functions
	VxCollection ()
	Initializes a new instance of the VxCollection<T> struct. More...
	VxCollection (const VxCollection &ref)
	Initializes a new instance of the VxCollection<T> struct. More...
	~VxCollection ()
	Finalizes an instance of the VxCollection<T> class. More...
void	Clear ()
	Clears this instance. More...

Public Attributes
int	collectionSize
	The size of collection. More...
int	filterSize
	The size of filters. More...
int	startIndex
	The start index. More...
int	totalItems
	The total amount of items. More...
T	collection
	The collection of resources. More...
VxCollectionFilter *	filters
	The filters to be applied to the collection request. More...

Detailed Description

template<typename T>
struct VxSdk::VxCollection< T >

Represents a collection of resources.

Definition at line 14 of file VxCollection.h.

Constructor & Destructor Documentation

template<typename T>

VxSdk::VxCollection< T >::VxCollection ( )

inline

Initializes a new instance of the VxCollection<T> struct.

Definition at line 19 of file VxCollection.h.

                       {
            Clear();
        }

template<typename T>

VxSdk::VxCollection< T >::VxCollection ( const VxCollection< T > &  ref )

inline

Initializes a new instance of the VxCollection<T> struct.

Parameters

ref	The reference.

Definition at line 27 of file VxCollection.h.

                                              {
            this->collectionSize = ref.collectionSize;
            this->filterSize = ref.filterSize;
            this->startIndex = ref.startIndex;
            this->totalItems = ref.totalItems;
            this->collection = ref.collection;
            this->filters = ref.filters;
        }

template<typename T>

VxSdk::VxCollection< T >::~VxCollection ( )

inline

Finalizes an instance of the VxCollection<T> class.

Definition at line 39 of file VxCollection.h.

                        {
            Clear();
        }

Member Function Documentation

template<typename T>

void VxSdk::VxCollection< T >::Clear ( )

inline

Clears this instance.

Definition at line 46 of file VxCollection.h.

                     {
            this->collectionSize = 0;
            this->filterSize = 0;
            this->startIndex = 0;
            this->totalItems = 0;
            this->collection = T();
            this->filters = nullptr;
        }

Member Data Documentation

template<typename T>

T VxSdk::VxCollection< T >::collection

The collection of resources.

Definition at line 75 of file VxCollection.h.

template<typename T>

int VxSdk::VxCollection< T >::collectionSize

The size of collection.

Definition at line 59 of file VxCollection.h.

template<typename T>

VxCollectionFilter* VxSdk::VxCollection< T >::filters

The filters to be applied to the collection request.

Definition at line 79 of file VxCollection.h.

template<typename T>

int VxSdk::VxCollection< T >::filterSize

The size of filters.

Definition at line 63 of file VxCollection.h.

template<typename T>

int VxSdk::VxCollection< T >::startIndex

The start index.

Definition at line 67 of file VxCollection.h.

template<typename T>

int VxSdk::VxCollection< T >::totalItems

The total amount of items.

Definition at line 71 of file VxCollection.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/VxCollection.h