ifw::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 ifw::odp::Array:

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

Protected Attributes
cpl_array *	m_cpl_array
	CPL array object.

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

Additional Inherited Members
Protected Member Functions inherited from ifw::odp::Error
std::string	GetErrorMsg () const
	Get CPL error message.

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

Array() [1/3]

ifw::odp::Array::Array

(

)

Class constructor.

Returns

none

Array() [2/3]

ifw::odp::Array::Array ( cpl_size length )

explicit

Class constructor.

Returns

none

Array() [3/3]

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

explicit

Copy constructor.

Parameters

[in]

array

Reference to the array to be copied

Returns

none

~Array()

ifw::odp::Array::~Array

(

)

Class destructor.

Returns

none

Member Function Documentation

Get()

double ifw::odp::Array::Get

(

int

index

)

GetCplArray()

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

inline

Get CPL array pointer.

Returns

CPL array pointer

GetData()

double * ifw::odp::Array::GetData ( )

inline

Get pointer to array data buffer.

Returns

Pointer to the data buffer

GetSize()

cpl_size ifw::odp::Array::GetSize ( ) const

inline

Get array size.

Returns

Array size

IsArray()

bool ifw::odp::Array::IsArray ( ) const

inline

Check is CPL array is not null.

Returns

TRUE is CPL array is not null, FALSE otherwise.

Set()

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

SetCplArray()

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

inline

Set CPL array.

Parameters

[in]

array

CPL array

Returns

none

Friends And Related Symbol Documentation

operator<<

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

m_cpl_array

cpl_array* ifw::odp::Array::m_cpl_array

protected

CPL array object.

---

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

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