Public Types | Public Member Functions | Friends | List of all members
series< Point > Class Template Reference

#include <series.h>

Inheritance diagram for series< Point >:
data_point_collection< Point >

Public Types

enum  series_types { Candlestick, Line, Bar }
 
typedef std::vector< std::string > options_t
 
typedef data_point_collection< Point > point_collection_t
 
typedef point_collection_t::const_iterator const_iterator
 
typedef point_collection_t::const_reference const_reference
 
typedef point_collection_t::reference reference
 
typedef point_collection_t::size_type size_type
 
- Public Types inherited from data_point_collection< Point >
typedef point_vector_t::const_reference const_reference
 
typedef point_vector_t::reference reference
 
typedef point_vector_t::size_type size_type
 
typedef point_vector_t::const_iterator const_iterator
 

Public Member Functions

 series (const std::string &title="", const std::string color="Blue", const series_types series_type=Candlestick)
 
const std::string & title () const
 
const std::string & color () const
 
series_types series_type () const
 
const options_t & options () const
 
void add_option (const std::string &option)
 
void color (const std::string &color_name)
 
- Public Member Functions inherited from data_point_collection< Point >
const Point & operator[] (const size_t index) const INTEROP_THROW_SPEC((model
 
Point & operator[] (const size_t index) INTEROP_THROW_SPEC((model
 
const Point & at (const size_t index) const INTEROP_THROW_SPEC((model
 
size_t size () const
 
void assign (const size_t n, const Point &val)
 
void resize (const size_t n)
 
const_iterator begin () const
 
const_iterator end () const
 
void push_back (const Point &point)
 

Friends

std::ostream & operator<< (std::ostream &out, const series &data)
 
std::istream & operator>> (std::istream &in, series &data)
 

Detailed Description

template<class Point>
class illumina::interop::model::plot::series< Point >

Series of data points and meta data describing points

Member Typedef Documentation

typedef point_collection_t::const_iterator const_iterator

Constant iterator

typedef point_collection_t::const_reference const_reference

Constant reference to data point

typedef std::vector<std::string> options_t

Collection of options for a plot

typedef data_point_collection<Point> point_collection_t

Defines a collection of points

typedef point_collection_t::reference reference

Reference to data point

typedef point_collection_t::size_type size_type

Size type

Member Enumeration Documentation

enum series_types

Type of plot to display

Enumerator
Candlestick 

Candle stick points

Line 

Line points

Bar 

Bar points

Constructor & Destructor Documentation

series ( const std::string &  title = "",
const std::string  color = "Blue",
const series_types  series_type = Candlestick 
)
inline

Constructor

Parameters
titlelabel of series in legend
colorcolor for points
series_typetype of the series

Member Function Documentation

void add_option ( const std::string &  option)
inline

Collection of options

Parameters
optionstring name of option
void color ( const std::string &  color_name)
inline

Get color of the series

Parameters
color_namecolor name or code of the series

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const series< Point > &  data 
)
friend
std::istream& operator>> ( std::istream &  in,
series< Point > &  data 
)
friend
The documentation for this class was generated from the following file: