BeSpiceWaveParserLimitedEdition
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Static Public Attributes | List of all members
af_py_waveform_parser_limited_edition.section Class Reference

This class defines section objects. More...

Public Member Functions

def __init__
 A unique section identifier needs to be passed to the constructor to build a valid section object. More...
 
def findCurves
 This function looks for the curves of a given section matching a search string. More...
 
def findProperty
 This function looks for the the section's property defined by it's name. More...
 
def getCurves
 This function returns all curves of a section. More...
 
def getProperties
 This function retrieves all section properties and returns them in a dictionary. More...
 
def getRunParameters
 This function retrieves all section run parameters and returns them in a dictionary. More...
 
def isValid
 This function returns 1 if the section objectis valid. More...
 
def release
 This function releases a section. More...
 

Static Public Attributes

int sectionId = 0
 This member defines the unique section identifier. More...
 

Detailed Description

This class defines section objects.

Section objects are defined by their section identifier, which is an integer value. A section object represents a data sections that has been generated when reading a file. One file might define several data sections. For example if several simulation runs or analyses were performed during the simulation.

Constructor & Destructor Documentation

def af_py_waveform_parser_limited_edition.section.__init__ (   self,
  section_id 
)

A unique section identifier needs to be passed to the constructor to build a valid section object.

Otherwise the sectionId member is set to 0, which means that the section object isn't valid.

Member Function Documentation

def af_py_waveform_parser_limited_edition.section.findCurves (   search_string)

This function looks for the curves of a given section matching a search string.

The curves are returned in a list of curve objects.

def af_py_waveform_parser_limited_edition.section.findProperty (   property_name)

This function looks for the the section's property defined by it's name.

It returns the property's value.

def af_py_waveform_parser_limited_edition.section.getCurves ( )

This function returns all curves of a section.

The curves are returned in a list of curve objects.

def af_py_waveform_parser_limited_edition.section.getProperties ( )

This function retrieves all section properties and returns them in a dictionary.

def af_py_waveform_parser_limited_edition.section.getRunParameters ( )

This function retrieves all section run parameters and returns them in a dictionary.

def af_py_waveform_parser_limited_edition.section.isValid ( )

This function returns 1 if the section objectis valid.

def af_py_waveform_parser_limited_edition.section.release ( )

This function releases a section.

Member Data Documentation

int af_py_waveform_parser_limited_edition.section.sectionId = 0
static

This member defines the unique section identifier.

It is an integer value.


The documentation for this class was generated from the following file: