odp::Array Class Reference

This class is C++ wrapper for a CPL array object. It provides a simplified interface to the INS software. More...

#include <array.hpp>

Inheritance diagram for odp::Array:

Public Member Functions
	Array ()
	Class constructor. More...
	Array (cpl_size length)
	Class constructor. More...
	Array (const Array &array)
	Copy constructor. More...
	~Array ()
	Class destructor. More...
bool	IsArray () const
	Check is CPL array is not null. More...
cpl_array *	GetCplArray () const
	Get CPL array pointer. More...
cpl_size	GetSize () const
	Get array size. More...
void	Set (int index, double value)
double	Get (int index)
void	SetCplArray (cpl_array *array)
	Set CPL array. More...
double *	GetData ()
	Get pointer to array data buffer. More...
Public Member Functions inherited from odp::Error
	Error ()
	Class constructor. More...
virtual	~Error ()
	Class destructor. More...
void	ResetCplError ()
	Reset CPL error and internal error flag. More...
bool	CheckCplError () const
	Check if there is an error in CPL. More...

Protected Attributes
cpl_array *	m_cpl_array
	CPL array object. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Array &array)
	Overload operator<<. More...

Additional Inherited Members
Protected Member Functions inherited from odp::Error
void	AddCplError () const
	Add CPL error to the error stack. More...
std::string	GetErrorMsg () const
	Get CPL error message. More...
Static Protected Member Functions inherited from odp::Error
static void	DumpError (unsigned self, unsigned first, unsigned last)
	Dump current CPL error. More...

Detailed Description

This class is C++ wrapper for a CPL array object. It provides a simplified interface to the INS software.

Array - CPL array wrapper class

See Also

CPL Reference: http://www.eso.org/observing/cpl/reference_3.0/ or above

Constructor & Destructor Documentation

odp::Array::Array

(

)

Class constructor.

Returns

none

odp::Array::Array ( cpl_size  length )

explicit

Class constructor.

Returns

none

odp::Array::Array ( const Array &  array )

explicit

Copy constructor.

Parameters

[in]

array

Reference to the array to be copied

Returns

none

odp::Array::~Array

(

)

Class destructor.

Returns

none

Member Function Documentation

double odp::Array::Get

(

int

index

)

cpl_array* odp::Array::GetCplArray ( ) const

inline

Get CPL array pointer.

Returns

CPL array pointer

double* odp::Array::GetData ( )

inline

Get pointer to array data buffer.

Returns

Pointer to the data buffer

cpl_size odp::Array::GetSize ( ) const

inline

Get array size.

Returns

Array size

bool odp::Array::IsArray ( ) const

inline

Check is CPL array is not null.

Returns

TRUE is CPL array is not null, FALSE otherwise.

void odp::Array::Set	(	int	index,
		double	value
	)

void odp::Array::SetCplArray ( cpl_array *  array )

inline

Set CPL array.

Parameters

[in]

array

CPL array

Returns

none

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const Array &  array  )

friend

Overload operator<<.

Parameters

[in]	os	Output stream
[in]	array	Array to be dumped into the output stream.

Returns

Reference to the output stream

Member Data Documentation

cpl_array* odp::Array::m_cpl_array

protected

CPL array object.

---

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

• cppcpl/src/include/cppcpl/array.hpp
• cppcpl/src/array.cpp