ForeignArrayParameterAccessor.h

Classes

ForeignBaseArrayParameterAccessor -- Base class for access to Glish data structure Arrays (full description)
ForeignBaseVectorParameterAccessor -- Base class for access to Glish data structure Vectors (full description)
ForeignArrayParameterAccessor -- Access an array of foreign Glish data structures (full description)
ForeignVectorParameterAccessor -- Base class for access to Foreign vectors (full description)
ForeignNSArrayParameterAccessor -- Access an array of non-standard Glish data structures (full description)
ForeignNSVectorParameterAccessor -- Access a vector of non-standard Glish data structures (full description)

template<class T> class ForeignBaseArrayParameterAccessor : public ParameterAccessor<Array<T> >

Interface

Public Members
typedef Bool (*PACFR)(String &, T &, const GlishRecord &)
typedef Bool (*PACST)(String &, T &, const String &)
typedef Bool (*PACTO)(String &, PACTO &, const T&)
typedef Bool (T::*FRGR)(String &, const RecordInterface &)
typedef Bool (T::*FRST)(String &, const String &)
typedef Bool (T::*TOGR)(String &, RecordInterface &) const
ForeignBaseArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignBaseArrayParameterAccessor()
Bool fromRecord(String & error, PACFR from, PACST frst, FRGR fromGR, FRST fromST, Bool isvector=False)
Bool toRecord(String & error, PACTO to, TOGR toGR, ID idfr, IDGR idGR) const
virtual void reset()
Private Members
ForeignBaseArrayParameterAccessor()
Public Members
using ParameterAccessor< ParameterAccessor<T> >::operator()

Description

Synopsis

See ForeignParameterAccessor

Member Description

typedef Bool (*PACFR)(String &, T &, const GlishRecord &)
typedef Bool (*PACST)(String &, T &, const String &)
typedef Bool (*PACTO)(String &, PACTO &, const T&)
typedef Bool (T::*FRGR)(String &, const RecordInterface &)
typedef Bool (T::*FRST)(String &, const String &)
typedef Bool (T::*TOGR)(String &, RecordInterface &) const

ForeignBaseArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignBaseArrayParameterAccessor()

Destructor

Bool fromRecord(String & error, PACFR from, PACST frst, FRGR fromGR, FRST fromST, Bool isvector=False)

Convert a Glish record to a C++ structure array or vector

Bool toRecord(String & error, PACTO to, TOGR toGR, ID idfr, IDGR idGR) const

Convert a C++ structure to a Glish Record

virtual void reset()

Reset size on action

ForeignBaseArrayParameterAccessor()

Default constructor (not implemented)

using ParameterAccessor< ParameterAccessor<T> >::operator()


template<class T> class ForeignBaseVectorParameterAccessor : public ParameterAccessor<Vector<T> >

Interface

typedef Bool (*PACFR)(String &, T &, const GlishRecord &)
typedef Bool (*PACST)(String &, T &, const String &)
typedef Bool (*PACTO)(String &, PACTO &, const T&)
typedef Bool (T::*FRGR)(String &, const RecordInterface &)
typedef Bool (T::*FRST)(String &, const String &)
typedef Bool (T::*TOGR)(String &, RecordInterface &) const
ForeignBaseVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignBaseVectorParameterAccessor()
Bool fromRecord(String & error, PACFR from, PACST frst, FRGR fromGR, FRST fromST)
Bool toRecord(String & error, PACTO to, TOGR toGR, ID idfr, IDGR idGR) const
virtual void reset()
Private Members
ForeignBaseVectorParameterAccessor()
Public Members
using ParameterAccessor< ParameterAccessor<T> >::operator()

Description

Synopsis

See ForeignParameterAccessor

Member Description

typedef Bool (*PACFR)(String &, T &, const GlishRecord &)
typedef Bool (*PACST)(String &, T &, const String &)
typedef Bool (*PACTO)(String &, PACTO &, const T&)
typedef Bool (T::*FRGR)(String &, const RecordInterface &)
typedef Bool (T::*FRST)(String &, const String &)
typedef Bool (T::*TOGR)(String &, RecordInterface &) const

ForeignBaseVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignBaseVectorParameterAccessor()

Destructor

Bool fromRecord(String & error, PACFR from, PACST frst, FRGR fromGR, FRST fromST)

Convert a Glish record to a C++ structure

Bool toRecord(String & error, PACTO to, TOGR toGR, ID idfr, IDGR idGR) const

Convert a C++ structure to a Glish Record

virtual void reset()

Reset size on action

ForeignBaseVectorParameterAccessor()

Default constructor (not implemented)

using ParameterAccessor< ParameterAccessor<T> >::operator()


template<class T> class ForeignArrayParameterAccessor : public ForeignBaseArrayParameterAccessor<T>

Interface

ForeignArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignArrayParameterAccessor()
virtual Bool fromRecord(String &error)
virtual Bool toRecord(String &error) const
virtual void reset()
Private Members
ForeignArrayParameterAccessor()
Public Members
using ForeignBaseArrayParameterAccessor<T>::operator()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

This class makes it possible to transfer Arrays (and Vectors) between Glish and C++, using the standard Parameter<> structure. Its use is explained in ForeignParameterAccessor.h.

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Member Description

ForeignArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignArrayParameterAccessor()

Destructor

virtual Bool fromRecord(String &error)

Convert a Glish record to an Array of C++ structures

virtual Bool toRecord(String &error) const

Convert an Array of C++ structures to a Glish Record

virtual void reset()

Reset size on action

ForeignArrayParameterAccessor()

using ForeignBaseArrayParameterAccessor<T>::operator()


template<class T> class ForeignVectorParameterAccessor : public ForeignBaseVectorParameterAccessor<T>

Interface

ForeignVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignVectorParameterAccessor()
virtual Bool fromRecord(String &error)
virtual Bool toRecord(String &error) const
virtual void reset()
Private Members
ForeignVectorParameterAccessor()
Public Members
using ForeignBaseVectorParameterAccessor<T>::operator()

Description

Synopsis

See ForeignParameterAccessor

Member Description

ForeignVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignVectorParameterAccessor()

Destructor

virtual Bool fromRecord(String &error)

Convert a Glish record to a Vector of C++ structures

virtual Bool toRecord(String &error) const

Convert a Vector of C++ structures to a Glish Record

virtual void reset()

Reset size on action

ForeignVectorParameterAccessor()

Default constructor (not implemented)

using ForeignBaseVectorParameterAccessor<T>::operator()


template<class T> class ForeignNSArrayParameterAccessor : public ForeignBaseArrayParameterAccessor<T>

Interface

ForeignNSArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignNSArrayParameterAccessor()
virtual Bool fromRecord(String & error)
virtual Bool toRecord(String & error) const
virtual void reset()
Private Members
ForeignNSArrayParameterAccessor()
Public Members
using ForeignBaseArrayParameterAccessor<T>::operator()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

This class makes it possible to transfer Arrays (and Vectors) between Glish and C++, using the standard Parameter<> structure. Its use is explained in ForeignParameterAccessor.h.

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Member Description

ForeignNSArrayParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignNSArrayParameterAccessor()

Destructor

virtual Bool fromRecord(String & error)

Convert a Glish record to an Array of C++ structures

virtual Bool toRecord(String & error) const

Convert an Array of C++ structures to a Glish Record

virtual void reset()

Reset size on action

ForeignNSArrayParameterAccessor()

using ForeignBaseArrayParameterAccessor<T>::operator()


template<class T> class ForeignNSVectorParameterAccessor : public ForeignBaseVectorParameterAccessor<T>

Interface

ForeignNSVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)
~ForeignNSVectorParameterAccessor()
virtual Bool fromRecord(String & error)
virtual Bool toRecord(String & error) const
virtual void reset()
Private Members
ForeignNSVectorParameterAccessor()
Public Members
using ForeignBaseVectorParameterAccessor<T>::operator()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

This class makes it possible to transfer Arrays (and Vectors) between Glish and C++, using the standard Parameter<> structure. Its use is explained in ForeignParameterAccessor.h.

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Member Description

ForeignNSVectorParameterAccessor(const String & name, ParameterSet::Direction direction, GlishRecord * values)

Constructor

~ForeignNSVectorParameterAccessor()

Destructor

virtual Bool fromRecord(String & error)

Convert a Glish record to a Vector of C++ structures

virtual Bool toRecord(String & error) const

Convert a Vector of C++ structures to a Glish Record

virtual void reset()

Reset size on action

ForeignNSVectorParameterAccessor()

Default constructor (not implemented)

using ForeignBaseVectorParameterAccessor<T>::operator()