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)
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()
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
Constructor
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
Default constructor (not implemented)
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
- 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()
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
Constructor
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
Default constructor (not implemented)
Interface
Public Members
- 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()
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
- SomeClass
- SomeOtherClass
- some concept
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
- add this feature
- fix this bug
- start discussion of this possible extension
Member Description
Constructor
Destructor
Convert a Glish record to an Array of C++ structures
Convert an Array of C++ structures to a Glish Record
virtual void reset()
Reset size on action
Interface
Public Members
- 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()
Synopsis
See ForeignParameterAccessor
Member Description
Constructor
Destructor
Convert a Glish record to a Vector of C++ structures
Convert a Vector of C++ structures to a Glish Record
virtual void reset()
Reset size on action
Default constructor (not implemented)
Interface
Public Members
- 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()
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
- SomeClass
- SomeOtherClass
- some concept
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
- add this feature
- fix this bug
- start discussion of this possible extension
Member Description
Constructor
Destructor
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
Interface
Public Members
- 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()
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
- SomeClass
- SomeOtherClass
- some concept
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
- add this feature
- fix this bug
- start discussion of this possible extension
Member Description
Constructor
Destructor
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
Default constructor (not implemented)