ZCoordObjStream Class Reference

#include <ZCoordObjStream.H>

Inheritance diagram for ZCoordObjStream:

Public Member Functions
virtual void	set_custom_coord (const char *coord_name, Compar order=ASCENT_ORDER)
virtual void	set_secondary_order (const char *secondary_name, Compar order=ASCENT_ORDER)
virtual void	set_tertiary_order (const char *tertiary_name, Compar order=ASCENT_ORDER)
virtual Logic	get_coord_range (float c[2])=0
virtual float	average_coord_step ()=0
virtual Logic	go_first_coord ()=0
virtual Logic	go_next_coord ()=0
virtual float	coord ()=0
virtual int	ensemble_length () const =0

Detailed Description

Abstract class for stream of items ordered by some coordinate. Several items may have the same coordinate (so called 'ensemble').

Member Function Documentation

virtual float ZCoordObjStream::average_coord_step ( )

pure virtual

Get average coordinate step between objects.

Implemented in ZTrSetStream.

virtual float ZCoordObjStream::coord ( )

pure virtual

Get current coordinate in case of previous go_*_coord() succeeded.

Implemented in ZTrSetStream.

virtual int ZCoordObjStream::ensemble_length ( ) const

pure virtual

Get number of records found for this coordinate (always >=1).

Implemented in ZTrSetStream.

virtual Logic ZCoordObjStream::get_coord_range ( float  c[2] )

pure virtual

Get range of coordinates respecting order of the stream or return FALSE in case of empty range.

Implemented in ZTrSetStream.

virtual Logic ZCoordObjStream::go_first_coord ( )

pure virtual

Reset iterator. Returns TRUE on success and FALSE on failure (empty stream).

Implemented in ZTrSetStream.

virtual Logic ZCoordObjStream::go_next_coord ( )

pure virtual

Go to next iteration. Returns TRUE on success and FALSE on failure (end of stream).

Implemented in ZTrSetStream.

virtual void ZCoordObjStream::set_custom_coord ( const char *  coord_name, Compar  order = ASCENT_ORDER  )

virtual

Set custom primary coordinate and items order. May be not available in derivations. May be implemented partially - only name or only order is interpreted.

Reimplemented in ZTrSetStream.

virtual void ZCoordObjStream::set_secondary_order ( const char *  secondary_name, Compar  order = ASCENT_ORDER  )

virtual

Set custom secondary coordinate and items order. Does not affect iterator methods and and get_coord_range() but changes order of items with the same primary coordinate. May be not available in derivations. May be implemented partially - only name or only order is interpreted.

Reimplemented in ZTrSetStream.

virtual void ZCoordObjStream::set_tertiary_order ( const char *  tertiary_name, Compar  order = ASCENT_ORDER  )

virtual

Set custom tertiary coordinate and items order. Does not affect iterator methods and and get_coord_range() but changes order of items with the same primary and secondary coordinates. May be not available in derivations. May be implemented partially - only name or only order is interpreted.

Reimplemented in ZTrSetStream.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/zm/ZCoordObjStream.H