Collection Class Documentation
classCollectionNamespace:datalogics_interface
Detailed Description
The class illustrates how to process a collection's schema. It also describes sorting of a portfolio.
Referenced by
Constructor & Destructor Documentation
Collection
Collection(Collection &&)Parameters
~Collection
~Collection()Member Function Documentation
change_view_mode
voidchange_view_mode(CollectionViewTypeview, CollectionSplitTypesplit)Parameters
view: CollectionViewTypeone of the members of CollectionViewMode enum.
split: CollectionSplitTypeenum of split mode (selector)
Returns:
voidSetCollectionView sets view mode value to the Collection.
get_schema
CollectionSchemaget_schema()Returns:
Schema object.The Schema object does not have constructor. Only Collection is able to create Schema.
get_sort
std::vector< CollectionSortItem >get_sort()Returns:
the list of CollectionSortItem, which contains field/fields name to sort Collection by and sort order.GetSort gets sort parameters for the Collection.
operator=
Collection &operator=(Collection &&)Parameters
Returns:
Collection &set_sort
voidset_sort(const std::vector< CollectionSortItem > &sort_items)Parameters
sort_items: const std::vector< CollectionSortItem > &the list of CollectionSortItem.
Returns:
voidSetSort allows to set field/fields to sort by as well as sort order (ascending or descending).