src/

amespahdbidlsuite_species__define.pro

Class to hold and access the data and properties in a parsed database.

Updated versions of the NASA Ames PAH IR Spectroscopic Database and more information can be found at: www.astrochemistry.org/pahdb.

Examples

Creating, setting and printing Species info:

 IDL> species = OBJ_NEW('AmesPAHdbIDLSuite_Species')
 IDL> species->Set,data
 IDL> species->Print
 IDL> OBJ_DESTROY,info

Author information

Author

Dr. Christiaan Boersma

Copyright

BSD licensed

History

Changes:

 11-17-2023
 Add GETUIDS. Christiaan Boersma.
 05-08-2019
 In the absence of Michael Galloy's STR_REPLACE function
 FormatFormulae will print a message and return. Christiaan
 Boersma.
 10-17-2017
 Fixed units definition in TRANSITIONS.
 Christiaan Boersma.
 02-01-2015
 First version of the file. Christiaan Boersma.

Other file information

Uses:: AmesPAHdbIDLSuite_Species, AmesPAHdbIDLSuite_Transitions, AmesPAHdbIDLSuite_Laboratory_Spectrum, AmesPAHdbIDLSuite_Geometry

Class description for AmesPAHdbIDLSuite_Species

Properties

Properties in AmesPAHdbIDLSuite_Species

Comments init
Data init
PAHdb init
References init
Type init
Uids init
Version init

Routines

Routines from amespahdbidlsuite_species__define.pro

AmesPAHdbIDLSuite_Species::FormatFormulae: Make the formulae look pretty by embedding formatting commands.
AmesPAHdbIDLSuite_Species::Print [, UID] [, Str=string array]: Output species description.
result = AmesPAHdbIDLSuite_Species::Comments(): Retrieves species comments.
result = AmesPAHdbIDLSuite_Species::References(): Retrieves species references.
result = AmesPAHdbIDLSuite_Species::Transitions(): Retrieves species transitions.
result = AmesPAHdbIDLSuite_Species::Geometry(): Retrieves species geometry.
result = AmesPAHdbIDLSuite_Species::Laboratory(): Retrieves species laboratory spectra.
result = AmesPAHdbIDLSuite_Species::Get(): Retrieves the AmesPAHdbIDLSuite_Species representation in a structure.
AmesPAHdbIDLSuite_Species::Set [, Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, References=AmesPAHdb_Reference_S array] [, Comments=AmesPAHdb_Comment_S array]: Populates the AmesPAHdbIDLSuite_Species-instance.
result = AmesPAHdbIDLSuite_Species::Init( [Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, References=AmesPAHdb_Reference_S array] [, Comments=AmesPAHdb_Comment_S array]): Create an AmesPAHdbIDLSuite_Species-instance

Routine details

top source AmesPAHdbIDLSuite_Species::FormatFormulae

MARKUP

AmesPAHdbIDLSuite_Species::FormatFormulae

Make the formulae look pretty by embedding formatting commands.

Other attributes

Uses:: STR_REPLACE, by, Michael, Galloy

top source AmesPAHdbIDLSuite_Species::Print

INFORMATIVE

AmesPAHdbIDLSuite_Species::Print [, UID] [, Str=string array]

Output species description.

Parameters

UID in optional type=long

UID of the species

Keywords

Str out optional type=string array

Ouput to Str

top source AmesPAHdbIDLSuite_Species::Comments

SET/GET

result = AmesPAHdbIDLSuite_Species::Comments()

Retrieves species comments.

Return value

AmesPAHdb_Comment_S array

top source AmesPAHdbIDLSuite_Species::References

SET/GET

result = AmesPAHdbIDLSuite_Species::References()

Retrieves species references.

Return value

AmesPAHdb_Reference_S array

top source AmesPAHdbIDLSuite_Species::Transitions

SET/GET

result = AmesPAHdbIDLSuite_Species::Transitions()

Retrieves species transitions.

Return value

AmesPAHdbIDLSuite_Transitions-instance

top source AmesPAHdbIDLSuite_Species::Geometry

SET/GET

result = AmesPAHdbIDLSuite_Species::Geometry()

Retrieves species geometry.

Return value

AmesPAHdbIDLSuite_Geometry-instance

top source AmesPAHdbIDLSuite_Species::Laboratory

SET/GET

result = AmesPAHdbIDLSuite_Species::Laboratory()

Retrieves species laboratory spectra.

Return value

AmesPAHdbIDLSuite_Laboratory_Spectrum-instance

top source AmesPAHdbIDLSuite_Species::Get

SET/GET

result = AmesPAHdbIDLSuite_Species::Get()

Retrieves the AmesPAHdbIDLSuite_Species representation in a structure.

Return value

Structure

top source AmesPAHdbIDLSuite_Species::Set

SET/GET

AmesPAHdbIDLSuite_Species::Set [, Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, References=AmesPAHdb_Reference_S array] [, Comments=AmesPAHdb_Comment_S array]

Populates the AmesPAHdbIDLSuite_Species-instance.

Parameters

Struct in optional type=struct

Data structure

Keywords

Type in optional type=string

Type of Data

Version in optional type=string

Versioning information

Data in optional type=struct

Data structure

PAHdb in optional type=pointer

Pointer to parsed database file

Uids in optional type=long array (1D)

UIDs in Data

References in optional type=AmesPAHdb_Reference_S array

References

Comments in optional type=AmesPAHdb_Comment_S array

Comments

top source AmesPAHdbIDLSuite_Species::Init

CLASS

result = AmesPAHdbIDLSuite_Species::Init( [Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, References=AmesPAHdb_Reference_S array] [, Comments=AmesPAHdb_Comment_S array])

Create an AmesPAHdbIDLSuite_Species-instance

Return value

AmesPAHdbIDLSuite_Species-instance

Parameters

Struct in optional type=struct

Data structure

Keywords

Type in optional type=string

Type of Data

Version in optional type=string

Versioning information

Data in optional type=struct

Data structure

PAHdb in optional type=pointer

Pointer to parsed database file

Uids in optional type=long array (1D)

UIDs in Data

References in optional type=AmesPAHdb_Reference_S array

References

Comments in optional type=AmesPAHdb_Comment_S array

Comments

File attributes

Modification date:	Fri Oct 24 12:51:08 2025
Lines:	323
Docformat:	rst rst