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::PAArgs Class Reference

#include <pa.h>

Inheritance diagram for simion::PAArgs:

simion::PATextHeader List of all members.

Detailed Description

Container class for a set of potential array attributes.

This allows any subset of the attributes to be passed at once into a given function, somewhat like named parameters in other languages. For example,

PA pa(PAArgs().nx(10).ny(20).symmetry(CYLINDRICAL));

See the PA class for details on the meaning of these attributes. Additional attributes are

  • fast_adjustable - whether array is fast adjustable
  • enable_points - whether to load/save point data (in addition to header)

Each attribute has three methods:

  • get value
  • get whether value is defined
  • set value

The typical usage by the caller is

args.nx(100);

The typical usage by the receiver is

if(args.nx_defined()) cout << args.nx(); // do something

Note that this class performs no checking on values. Checking is the responsibility of the PA class.

See also:
PA


Public Types

enum  arg_t {
  A_file = (1 << 0), A_mode = (1 << 1), A_max_voltage = (1 << 2), A_nx = (1 << 3),
  A_ny = (1 << 4), A_nz = (1 << 5), A_mirror_x = (1 << 6), A_mirror_y = (1 << 7),
  A_mirror_z = (1 << 8), A_field_type = (1 << 9), A_symmetry = (1 << 10), A_ng = (1 << 11),
  A_fast_adjustable = (1 << 12), A_enable_points = (1 << 13)
}
 Identifiers for arguments.


Public Member Functions

int defined ()
 Gets and OR-ed bit field of arguments defined.


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.