SIMION® Industry standard charged particle optics simulation software.
Newsflash: SIMION 8.1.1 is here: dielectrics, new examples + preview of permeability; ASMS2012 posters; major improvements to enhanced surface accuracy feature coming soon (details in Check for Updates).
About | Documentation | Community/Support | Downloads | Ordering

SL Libraries -- C++

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

simion::PAHeader Class Reference

#include <pa.h>

List of all members.


Detailed Description

Class that implements the header section of a PA file format.

Note: This class is normally not used by SL Toolkit users. The class provides a low-level interface to the PA file format, whereas the PA class provides a higher level interface to PA files.

The binary representation of this class is designed to be writen to the header section of the PA file.

Refer to page D-5 of the SIMION 7.0 manual for info on the PA file format.


Public Member Functions

 PAHeader ()
 Constructor.

 PAHeader (int mode, field_t field_type, symmetry_t symmetry, double max_voltage, int nx, int ny, int nz, bool mirror_x, bool mirror_y, bool mirror_z, int ng)
 Constructor.

bool mirror_x () const
 Get whether x mirroring is enabled.

bool mirror_y () const
 Get whether y mirroring is enabled.

bool mirror_z () const
 Get whether z mirroring is enabled.

field_t field_type () const
 Get whether field type identifier.

int ng () const
 Get ng magnetic scaling factor.

symmetry_t symmetry () const
 Get symmetry identifier.


Public Attributes

int mode_
 Mode (always -1).

int symmetry_
 Symmetry (PLANAR or CYLINDRICAL).

double max_voltage_
 max voltage limit

int nx_
 number of grid points in x direction

int ny_
 number of grid points in y direction

int nz_
 number of grid points in z direction

int mirror_
 first three lowest bits are the x, y, and z mirroring respectively.


Constructor & Destructor Documentation

simion::PAHeader::PAHeader int  mode,
field_t  field_type,
symmetry_t  symmetry,
double  max_voltage,
int  nx,
int  ny,
int  nz,
bool  mirror_x,
bool  mirror_y,
bool  mirror_z,
int  ng
 

Constructor.

Parameters:
mode mode (always -1)
field_type field type (ELECTROSTATIC or MAGNETIC)
symmetry symmetry (PLANAR or CYLINDRICAL)
max_voltage max voltage limit
nx number of grid points in x direction
ny number of grid points in y direction
nz number of grid points in z direction
mirror_x whether x mirroring is enabled
mirror_y whether y mirroring is enabled
mirror_z whether z mirroring is enabled
ng magnetic scaling factor

Member Data Documentation

int simion::PAHeader::mirror_
 

first three lowest bits are the x, y, and z mirroring respectively.

Remaining bits are the ng magnetic scaling factor.


The documentation for this class was generated from the following file: (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.
Any comments on this web page? (will be sent to SIS)
[Optional] Your name: email: phone/fax:
The SL Tookit™ and documentation is (c) 2003 Scientific Instrument Services, Inc. All Rights Reserved.
(c) 2003-2006 Scientific Instrument Services, Inc. (SIS). Contact SIS.