OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse Python API
Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C Class Reference

Python wrapper for C-structure, SpectrumWithMetadata. More...

Inheritance diagram for Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C:

Public Member Functions

 __init__ (self, int spectraLength)
 
list[float] getSpectra (self)
 

Public Attributes

 buffer = cast(spectraBuffer, POINTER(c_float))
 
 bufferLength = c_size_t(spectraLength)
 
 tickCount = c_uint64(0)
 

Static Protected Attributes

list _fields_
 

Detailed Description

Python wrapper for C-structure, SpectrumWithMetadata.

This is use internally by the wrapper. NOTE: The field order and type must match those of the C-structure we defined otherwise python will throw a runtime error. User must not alter this definition.

Definition at line 16 of file LighthouseTypes.py.

Constructor & Destructor Documentation

◆ __init__()

Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C.__init__ ( self,
int spectraLength )

Definition at line 28 of file LighthouseTypes.py.

Member Function Documentation

◆ getSpectra()

list[float] Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C.getSpectra ( self)

Definition at line 35 of file LighthouseTypes.py.

Member Data Documentation

◆ _fields_

list Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C._fields_
staticprotected
Initial value:
= [("buffer", POINTER(c_float)),
("bufferLength", c_size_t),
("tickCount", c_uint64)]

Definition at line 24 of file LighthouseTypes.py.

◆ buffer

Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C.buffer = cast(spectraBuffer, POINTER(c_float))

Definition at line 31 of file LighthouseTypes.py.

◆ bufferLength

Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C.bufferLength = c_size_t(spectraLength)

Definition at line 32 of file LighthouseTypes.py.

◆ tickCount

Python.oceandirect.LighthouseTypes.SpectrumWithMetadata_C.tickCount = c_uint64(0)

Definition at line 33 of file LighthouseTypes.py.