The SIMION SL™ Toolkit (version 1.2.1.0 - 2004-11-09)

SL Libraries -- C++

simion Namespace Reference


Detailed Description

The SIMION namespace for the SIMION SL Toolkit.

This namespace holds all SIMION SL Toolkit classes and members. Example:

#include <simion/pa.h> #include <iostream> using namespace simion; using namespace std; int main() { PA pa(); cout << pa.header_patxt() << endl; return 0; }


Classes

class  simion::Vector3R
 Class representing a three-dimensional vector of real components (x, y, z). More...

class  simion::PAPoint
 Constainer class representing a single data point in a PA. More...

class  simion::PAArgs
 Container class for a set of potential array attributes. More...

class  simion::PAHeader
 Class that implements the header section of a PA file format. More...

class  simion::PATextHeader
 header used by the PATXT format More...

class  simion::PAFormat
 Container class for options passed to PA.save(). More...

class  simion::PAPointInfo
 Container class used by PATextHandler to store information about a single data point mentioned in a PATXT file. More...

class  simion::PATextHandler
 Abstract base class for call-back handlers used by the by the PATXT processor. More...

class  simion::PA
 SIMION Potential array class. More...

class  simion::SLRemote
 SL Remote class. More...


Typedefs

typedef void(* slremote_handler )(...)
 Prototype for callback functions.


Enumerations

enum  symmetry_t { CYLINDRICAL = 0, PLANAR = 1 }
 symmetry constants. More...

enum  field_t { ELECTROSTATIC = 0, MAGNETIC = 1 }
 potential array field types. More...

enum  mirror_t { MIRROR_X = 1, MIRROR_Y = 2, MIRROR_Z = 4, MAGNETIC_PA = 8 }
 Bits definitions for the "mirror" field in the header of a PA file. More...


Enumeration Type Documentation

enum simion::field_t
 

potential array field types.

Enumeration values:
ELECTROSTATIC  electrostatic
MAGNETIC  magnetic

enum simion::mirror_t
 

Bits definitions for the "mirror" field in the header of a PA file.

See also:
PAHeader.
Enumeration values:
MIRROR_X  array mirrored in x
MIRROR_Y  array mirrored in y
MIRROR_Z  array mirrored in z
MAGNETIC_PA  is magnetic potential array (else assumed electrostatic array)

enum simion::symmetry_t
 

symmetry constants.

Enumeration values:
CYLINDRICAL  cylindrical symmetry
PLANAR  planar symmetry
(c) 2003-2004. Scientific Instrument Services, Inc. All Rights Reserved.

Please report any errors/comments regarding this web page:
  Name/e-mail/phone (optional):
 
The SIMION SL Toolkit™ and documentation is (c) 2003-2004 Scientific Instrument Services, Inc. All Rights Reserved.