Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
List of all members
iMS::CompensationFunction Class Reference

Class for performing Compensation related functions with the Synthesiser. More...

#include <include/Compensation.h>

Inheritance diagram for iMS::CompensationFunction:
Inheritance graph
[legend]
Collaboration diagram for iMS::CompensationFunction:
Collaboration graph
[legend]

Public Member Functions

Constructor & Destructor
 CompensationFunction ()
 Constructor for Compensation Object. More...
 
 ~CompensationFunction ()
 Destructor for Compensation Object.
 
 CompensationFunction (const CompensationFunction &)
 Copy Constructor.
 
CompensationFunctionoperator= (const CompensationFunction &)
 Assignment Constructor.
 
- Public Member Functions inherited from iMS::ListBase< CompensationPointSpecification >
bool operator== (ListBase const &rhs) const
 Equality Operator checks ListBase object for equivalence. More...
 
 ListBase (const std::string &Name="[no name]", const std::time_t &modified_time=std::time(nullptr))
 Create a default empty List with optional name parameter.
 
 ListBase (const ListBase &)
 Copy Constructor.
 
 ~ListBase ()
 Destructor.
 
ListBaseoperator= (const ListBase &)
 Assignment Constructor.
 
const std::array< std::uint8_t, 16 > GetUUID () const
 Returns a vector representing the Unique Identifier assigned to the ListBase object. More...
 
const std::time_t & ModifiedTime () const
 Returns Time at which the Container was last modified. More...
 
std::string ModifiedTimeFormat () const
 Returns Human-readable string for the time at which the Container was last modified. More...
 
const std::string & Name () const
 A string stored with the Container to aid human users in identifying its purpose. More...
 
std::string & Name ()
 
void assign (size_t n, const CompensationPointSpecification &val)
 Assign new content to ImageSequence list. More...
 
void push_front (const CompensationPointSpecification &val)
 Insert ImageSequenceEntry at beginning. More...
 
void pop_front ()
 Delete first ImageSequenceEntry. More...
 
void push_back (const CompensationPointSpecification &val)
 Add ImageSequenceEntry at end. More...
 
void pop_back ()
 Delete last ImageSequenceEntry. More...
 
iterator insert (iterator position, const CompensationPointSpecification &val)
 Insert ImageSequenceEntry. More...
 
iterator insert (iterator position, const_iterator first, const_iterator last)
 Insert Range Of ImageSequenceEntry's. More...
 
iterator erase (iterator position)
 Erase ImageSequenceEntry. More...
 
iterator erase (iterator first, iterator last)
 Erase a range of ImageSequenceEntry's. More...
 
void resize (size_t n)
 Change Size. More...
 
void clear ()
 Clear Content. More...
 
bool empty () const
 Returns True if the ListBase is empty. More...
 
std::size_t size () const
 Returns the Number of Entries in the ListBase. More...
 
iterator begin ()
 Returns an iterator pointing to the first element in the ListBase container. More...
 
const_iterator begin () const
 Returns a const_iterator pointing to the first element in the ListBase container. More...
 
iterator end ()
 Returns an iterator referring to the past-the-end element in the ListBase container. More...
 
const_iterator end () const
 Returns a const_iterator referring to the past-the-end element in the ListBase container. More...
 
const_iterator cbegin () const
 Returns a const_iterator pointing to the first element in the ListBase container. More...
 
const_iterator cend () const
 Returns a const_iterator referring to the past-the-end element in the ListBase container. More...
 

Additional Inherited Members

- Public Types inherited from iMS::ListBase< CompensationPointSpecification >
typedef std::list< CompensationPointSpecification >::iterator iterator
 Iterator defined for user manipulation of ListBase.
 
typedef std::list< CompensationPointSpecification >::const_iterator const_iterator
 Const Iterator defined for user readback of ListBase.
 

Detailed Description

Class for performing Compensation related functions with the Synthesiser.

The purpose of this class is to perform compensation tasks such as measuring the diffraction efficiency of an AO device across a range of frequencies. Such data can then be used to build Compensation tables.

It is not used for storing Compensation Table data or for downloading Compensation Tables. See the CompensationTable and CompensationTableDownload classes for these requirements.

Author
Dave Cowan
Date
2016-11-03
Since
1.3

Constructor & Destructor Documentation

iMS::CompensationFunction::CompensationFunction ( )

Constructor for Compensation Object.

Since
1.3

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