| Class Index | Cross Index | Extended TCL Command Index |
Name Description Adc2container Convert FrameCPP ADC data structure into LDAS Container. DetectorProc2container Convert FrameCPP Detector data structure into LDAS Container. DetectorSim2container Convert FrameCPP simulated Detector data structure into LDAS Container. Event2container Convert FrameCPP Event data structure into LDAS Container. History2container Convert FrameCPP History data structure into LDAS Container. Proc2container Convert FrameCPP Proc data structure into LDAS Container. Ser2container Convert FrameCPP Serial data structure into LDAS Container. SimData2container Convert FrameCPP SimData structure into LDAS Container. SimEvent2container Convert FrameCPP SimEvent data structure into LDAS Container. Summary2container Convert FrameCPP Summary data structure into LDAS Container. adcPointer2ProcPointer Convert frameCPP::AdcData to the frameCPP::ProcData. closeFrameFile Close a frame file concatAdcDataList Concatenate AdcData concatAdcDataList_r Concatenate AdcData -- get thread result concatAdcDataList_t Concatenate AdcData -- threaded concatFrameList Concatenate Frames. concatFrameList_r Concatenate Frames - return value concatFrameList_t Concatenate Frames - Threaded concatProcDataList Concatenate ProcData concatProcDataList_r Concatenate ProcData -- get thread result concatProcDataList_t Concatenate ProcData -- threaded concatSerDataList Concatenate SerData concatSerDataList_r Concatenate SerData -- thread return value concatSerDataList_t Concatenate SerData -- threaded concatSimDataList Concatenate SimData concatSimDataList_r Concatenate SimData -- get thread result concatSimDataList_t Concatenate SimData -- threaded createDetector Create a FrameCPP detector as ILWD container object. createFrame Create an empty FrameCPP Frame as ILWD container object. createHistory Create a FrameCPP History as ILWD container object. createMsg Create a FrameCPP Msg as ILWD container object. createOuterDetectorProcContainer Create an empty ILWD container to hold a linked list of FrameCPP ProcDetector data structures. createOuterDetectorSimContainer Create an empty ILWD container to hold a linked list of FrameCPP SimDetector data structures. createOuterHistoryContainer Create an empty ILWD container to hold a linked list of FrameCPP History data structures. createProcData Create a FrameCPP ProcData as ILWD container object. createRawData Create an empty FrameCPP RawData as ILWD container object. createRawFrame Create a simple template frame. createResampleState Create resampling state destructAdcData Delete an ADC object from memory. destructFrame Delete a frame object from memory. destructProcData Delete ProcData object from memory. destructResampleState Destroy resampling state dumpFrameCPPRegistry Display currently registered frameCPP objects. fullFrame2container Convert whole FrameCPP Frame into LDAS Container fullFrame2container_r Convert whole FrameCPP Frame into LDAS Container - thread return value fullFrame2container_t Convert whole FrameCPP Frame into LDAS Container - Threaded getChannelList Get ADC Channel List getChannelListFromFrameFile Get list of channels from frame file. getFrameAdcData Find ADC structure by name or access by index. getFrameAdcDataBias Get ADC bias. getFrameAdcDataChannelGroup Get ADC channel group number. getFrameAdcDataChannelNumber Get ADC channel number. getFrameAdcDataComment Get ADC comment. getFrameAdcDataDataValid Get ADC data valid flag. getFrameAdcDataFShift Get ADC frequency shift. getFrameAdcDataNBits Get ADC's number of bits per sample. getFrameAdcDataName Get ADC name. getFrameAdcDataNum Get the number of ADC structures in a frame. getFrameAdcDataPhase Get ADC phase at start of dataset. getFrameAdcDataSampleDt Get ADC sample delta T. getFrameAdcDataSampleRate Get ADC sampling rate. getFrameAdcDataSlice Get a slice of the ADC data. getFrameAdcDataSlope Get ADC Slope. getFrameAdcDataTimeOffset Get ADC time offset. getFrameAdcDataTimeOffsetN Get ADC time offset nanoseconds. getFrameAdcDataTimeOffsetS Get ADC time offset seconds. getFrameAdcDataUnits Get ADC engineering unit string. getFrameAttribute Return an attribute of a frame. getFrameAuxNum Get the number of auxiliary data structures in a frame. getFrameData Return frame data. getFrameDetectorArmXaltitude Get Detector altitude angle of arm X. getFrameDetectorArmXazimuth Get Detector orientation of arm X. getFrameDetectorArmXmidpoint Get Detector midpoint of arm X. getFrameDetectorArmYaltitude Get Detector altitude angle of arm Y. getFrameDetectorArmYazimuth Get Detector orientation of arm Y. getFrameDetectorArmYmidpoint Get Detector midpoint of arm Y. getFrameDetectorDataQuality Get Detector's dataQuality word. getFrameDetectorElevation Get Detector vertex elevation. getFrameDetectorLatitude Get Detector vertex latitude (degrees). getFrameDetectorLocalTime Get Detector's localTime offset. getFrameDetectorLongitude Get Detector vertex longitude (degrees). getFrameDetectorName Get Detector name. getFrameDetectorProc Find frame detector structure by name of access by index. getFrameDetectorProcNum Get the number of detector structures in a frame. getFrameDetectorQaBitList Get Detector's data quality descriptor list. getFrameDetectorSim Find frame simulation detector structure by name of access by index. getFrameDetectorSimNum Get the number of simulated detector structures in a frame. getFrameDictionary Get FrameCPP dictionary info. getFrameEvent Find Event structure by name or access by index. getFrameEventAmplitude Get Event amplitude. getFrameEventComment Get Event comment. getFrameEventEventStatus Get Event eventStatus. getFrameEventGTime Get Event's "maximum of event" time. getFrameEventInputs Get Event inputs. getFrameEventNParam Get Event number of additional event parameters. getFrameEventName Get Event name. getFrameEventNum Get the number of Event structures in a frame. getFrameEventParameterNames Get Event parameter Name at offset x. getFrameEventParameters Get Event parameter at offset x. getFrameEventProbability Get Event probability. getFrameEventStatistics Get Event statistics. getFrameEventTimeAfter Get Event timeAfter. getFrameEventTimeBefore Get Event timeBefore. getFrameFrameH Convert FrameCPP Frame Header into LDAS Container History and Detector structures are included too. getFrameFrameHDataQuality Get frame dataQuality getFrameFrameHDt Get frame period (delta t or Dt) getFrameFrameHFrame Get frame "frame number" getFrameFrameHGTime Get frame GPS time. getFrameFrameHName Get frame name. getFrameFrameHRun Get frame run number. getFrameFrameHULeapS Get frame leap seconds. getFrameHistory Find History structure by name or access by index. getFrameHistoryComment Get History comment. getFrameHistoryName Get History name. getFrameHistoryNum Get the number of history data structures in a frame. getFrameHistoryTime Get History time. getFrameMsg Find Msg structure by name or access by index. getFrameMsgAlarm Get Msg alarm (name of message). getFrameMsgGTime Get Msg GPS time. getFrameMsgMessage Get Msg message. getFrameMsgNum Get the number of Msg structures in a frame. getFrameMsgSeverity Get Msg severity. getFrameNumber Read the number of frames from the TOC structure getFrameProcData Find ProcData structure by name or access by index. getFrameProcDataAuxParam Get ProcData auxParam at offset x. getFrameProcDataAuxParamNames Get ProcData auxParam Name at offset x. getFrameProcDataBW Get ProcData BW at start of dataset. getFrameProcDataComment Get ProcData comment. getFrameProcDataFRange Get ProcData frequency range. getFrameProcDataFShift Get ProcData frequency shift. getFrameProcDataNAuxParam Get ProcData number of additional procdata parameter.s getFrameProcDataName Get ProcData name. getFrameProcDataNum Get the number of procesed data structures in a frame. getFrameProcDataPhase Get ProcData phase at start of dataset. getFrameProcDataSlice Get a slice of the Proc data. getFrameProcDataSliceIndex Get a slice of the Proc data. getFrameProcDataSubType Get ProcData subType. getFrameProcDataTRange Get ProcData time range. getFrameProcDataTimeOffset Get ProcData time offset. getFrameProcDataType Get ProcData type. getFrameSerData Find Serial Data structure by name or access by index. getFrameSerDataData Get Serial Data Data. getFrameSerDataName Get Serial Data name. getFrameSerDataNum Get the number of Serial data structures in a frame. getFrameSerDataSampleRate Get Serial Data sampling rate. getFrameSerDataTime Get Serial Data acquisition time. getFrameSimData Find SimData structure by name or access by index. getFrameSimDataComment Get SimData comment. getFrameSimDataFShift Get SimData frequency shift. getFrameSimDataName Get SimData name. getFrameSimDataNum Get the number of simulation data structures in a frame. getFrameSimDataPhase Get SimData phase at start of dataset. getFrameSimDataSampleRate Get SimData sampling rate. getFrameSimEvent Find SimEvent structure by name or access by index. getFrameSimEventAmplitude Get SimEvent amplitude. getFrameSimEventComment Get SimEvent comment. getFrameSimEventGTime Get SimEvent maximum of event time. getFrameSimEventInputs Get SimEvent inputs. getFrameSimEventNParam Get SimEvent number of additional event parameters. getFrameSimEventName Get SimEvent name. getFrameSimEventNum Get the number of SimEvent data structures in a frame. getFrameSimEventParameterNames Get SimEvent parameter Name at offset x. getFrameSimEventParameters Get SimEvent parameter at offset x. getFrameSimEventTimeAfter Get SimEvent timeAfter. getFrameSimEventTimeBefore Get SimEvent timeBefore. getFrameStatData Find StatData structure by name or by index. getFrameStatDataComment Get Static Data Structure comment string. getFrameStatDataName Get Static Data Structure name. getFrameStatDataRepresentation Get Static Data Structure representation string. getFrameStatDataTimeEnd Get Static Data Structure timeEnd variable. getFrameStatDataTimeStart Get Static Data Structure timeStart variable. getFrameStatDataVersion Get Static Data Structure version. getFrameSummary Find Summary structure by name or access by index. getFrameSummaryComment Get Summary comment. getFrameSummaryGTime Get Summary GPS time. getFrameSummaryName Get Summary name. getFrameSummaryNum Get the number of summary data structures in a frame. getFrameSummaryTest Get Summary test. ilwd2frame Convert an ILWD frame to a FrameCPP frame. ilwd2frame_r Convert an ILWD frame to a FrameCPP frame - thread return value ilwd2frame_t Convert an ILWD frame to a FrameCPP frame - Threaded insertAdcChanList Transfer Frame ADC channels into an ILWD container. insertDetector Insert detector structure from the FrameCPP `frame' into the LDAS container `f'. insertFrameData Insert ILWD frame data into an ILWD frame. insertHistory Insert all history structures from the FrameCPP 'frame' into the LDAS container `f'. insertSerChanList Transfer Frame Serial Data channels into an ILWD container. isFrameValid Is frame a valid object? normalizeFrameTimeILwd Normalize time data within Frame Container and subcontainers. openFrameFile Open a frame file for reading/writing. openFrameFile_r Open a frame file for reading/writing. - Thread return value openFrameFile_t Open a frame file for reading/writing. - Threaded readFrame Read a frame from a file. readFrame_r Read a frame from a file - Thread return value readFrame_t Read a frame from a file - Threaded recvFrameBinary Receive Frame as File recvFrameBinary_r Receive frame as file - thread return value recvFrameBinary_t Receive Frame as File - Threaded reduceRawFrames_r Create reduced data set of frames. - Thread return value. reduceRawFrames_t Create reduced data set of frames (threaded). rehashAdc Rehash adc name hash in the frame. rehashProc Rehash ProcData name hash in the frame. rehashSer Rehash serial data name hash in the frame. resampleAdcData Resample AdcData resampleAdcData_r Resample AdcData - Thread return value resampleAdcData_t Resample AdcData (threaded) resampleDelay Get resampling filter delay time resampleRawFrames_r Create resampled reduced data set of frames. - Thread return value. resampleRawFrames_t Create resampled reduced data set of frames (threaded). sendFrameBinary Send Frame as File sendFrameBinary_r Send frame as file - thread return value sendFrameBinary_t Send Frame as File -- Threaded setFrameAdcDataTimeOffset Set ADC time offset. setFrameProcDataTimeOffset Reset timeOffset for frameCPP::ProcData. writeFrame Write a frame to a file. writeFrame_r Write a frame to a file - thread return value writeFrame_t Write a frame to a file - Threaded
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ Adc2container adcPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| adcPtr | FrAdcData* | Adc data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::AdcData.
Exceptions:
| Exception | Description |
| SwigException | |
| null adcdata pointer | AdcData pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ DetectorProc2container detectorPtr ]
Parameters:
| Name | Type | Description |
| detectorPtr | FrDetector* | Detector pointer. |
Return value:
LdasContainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Detector.
Exceptions:
| Exception | Description |
| SwigException | |
| null detector pointer | Detector pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ DetectorProc2container detectorPtr]
Parameters:
| Name | Type | Description |
| detectorPtr | FrDetector* | Detector pointer. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Detector.
Exceptions:
| Exception | Description |
| SwigException | |
| null detector pointer | Detector pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ SimEvent2container simPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| simPtr | FrEvent* | SimEvent data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Event.
Exceptions:
| Exception | Description |
| SwigException | |
| null simevent pointer | SimEvent pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ History2container histPtr ]
Parameters:
| Name | Type | Description |
| histPtr | FrHistory* | History pointer. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::History.
Exceptions:
| Exception | Description |
| SwigException | |
| null history pointer | History pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ Proc2container procPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| procPtr | FrProcData* | Proc data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::ProcData.
Exceptions:
| Exception | Description |
| SwigException | |
| null procdata pointer | ProcData pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ Ser2container serPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| serPtr | FrSerData* | Serial data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SerData.
Exceptions:
| Exception | Description |
| SwigException | |
| null serdata pointer | SerData pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ SimData2container simPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| simPtr | FrSimData* | Sim data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SimData.
Exceptions:
| Exception | Description |
| SwigException | |
| null simdata pointer | SimData pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ SimEvent2container simPtr sec nsec dt ]
Parameters:
| Name | Type | Description |
| simPtr | FrSimEvent* | SimEvent data pointer. |
| sec | unsigned int | GPS frame timestamp. |
| sec | unsigned int | GPS frame timestamp. |
| dt | double | Frame delta time. |
Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SimEvent.
Exceptions:
| Exception | Description |
| SwigException | |
| null simevent pointer | SimEvent pointer is NULL. |
| bad_alloc | Memory allocation failed. |
Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.
Usage - Basic SWIG interface:
set ptResult [ Summary2container sumPtr ]
Parameters:
| Name | Type | Description |
| sumPtr | FrSummary* | Summary pointer. |
Return value:
LdasContainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Summary.
Exceptions:
| Exception | Description |
| SwigException | |
| null summary pointer | Summary pointer is NULL. |
| bad_alloc | Memory allocation failed. |
It creates new ProcData structure, which is not linked to any frame. Function returns newly constructed C++ FrameCPP::ProcData object. User is responsible for the destruction of returned object( 'destructProcData' ).
Usage - Basic SWIG interface:
set ptResult [ adcPointer2ProcPointer adcPtr ]
Parameters:
| Name | Type | Description |
| adcPtr | FrAdcData* | source AdcData data pointer |
Return value:
FrameCPP::FrProcData* ptResult - a pointer to newly allocated ProcData data structure.
Exceptions:
| Exception | Description |
| SwigException | |
| std::bad_alloc | Memory allocation failed. |
| null adcdata | AdcData pointer is null. |
Usage - Basic SWIG interface:
closeFrameFile ptFrameFile
Parameters:
| Name | Type | Description |
| ptFrameFile | FrameFile* | A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command. |
Exceptions:
| Exception | Description |
| invalid_frame_file | The pointer is invalid (it does not point to a valid object in the C++ layer). |
This command concatenates a list of AdcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatAdcDataList ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD AdcData objects in the C++ layer. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_adcdata | The container objects contain a frame data type other than AdcData. |
| bad_adcdata: not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_adcdata | The containers contain adcdata but it is malformed. |
| incompatible_adc_group | The containers contain AdcData but they have a different group. |
| incompatible_adc_channel | The containers contain AdcData but they have a different channel. |
| incompatible_adc_nbits | The containers contain AdcData but they have a different number of bits in the ADC output. |
| incompatible_channels | The containers contain AdcData but they are for different channels. |
| incompatible_adc_nbits | The containers contain AdcData but the ADC's which generated the data didn't have the same nBits. |
| incompatible_adc_bias | The containers contain AdcData but the ADC's which generated the data didn't have the same bias. |
| incompatible_adc_slope | The containers contain AdcData but the ADC's which generated the data didn't have the same slope. |
| incompatible_adc_units | The containers contain AdcData but the units are not the same. |
| incompatible_adc_samplerate | The containers contain AdcData but the sample rate is different. |
| incompatible_adc_fshift | The containers contain AdcData but the frequency shift is different. |
| unsupported_adcdata | The containers contain AdcData but one or more of them containe either more than one data vector or a multi-dimensional data vector. |
| incompatible_adcdata | The containers contain AdcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incomplete_adcdata | The containers contain AdcData, however the data in the first container does not run until the end of the frame. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | AdcData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | AdcData is missing "element". |
| invalid_format | AdcData is malformed. |
| SwigException |
This command concatenates a list of AdcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatAdcDataList_r tid]
Parameters:
| Name | Type | Description |
| tid | tid* | A pointer to a ilwd2frame thread. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_adcdata | The container objects contain a frame data type other than AdcData. |
| bad_adcdata: not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_adcdata | The containers contain adcdata but it is malformed. |
| incompatible_adc_group | The containers contain AdcData but they have a different group. |
| incompatible_adc_channel | The containers contain AdcData but they have a different channel. |
| incompatible_adc_nbits | The containers contain AdcData but they have a different number of bits in the ADC output. |
| incompatible_channels | The containers contain AdcData but they are for different channels. |
| incompatible_adc_nbits | The containers contain AdcData but the ADC's which generated the data didn't have the same nBits. |
| incompatible_adc_bias | The containers contain AdcData but the ADC's which generated the data didn't have the same bias. |
| incompatible_adc_slope | The containers contain AdcData but the ADC's which generated the data didn't have the same slope. |
| incompatible_adc_units | The containers contain AdcData but the units are not the same. |
| incompatible_adc_samplerate | The containers contain AdcData but the sample rate is different. |
| incompatible_adc_fshift | The containers contain AdcData but the frequency shift is different. |
| unsupported_adcdata | The containers contain AdcData but one or more of them containe either more than one data vector or a multi-dimensional data vector. |
| incompatible_adcdata | The containers contain AdcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incomplete_adcdata | The containers contain AdcData, however the data in the first container does not run until the end of the frame. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | AdcData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | AdcData is missing "element". |
| invalid_format | AdcData is malformed. |
| SwigException |
This command concatenates a list of AdcData objects, creating a new object in the process.
Usage - Basic SWIG interface:
set tid [concatAdcDataList_t ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD AdcData objects in the C++ layer. |
Return value:
tid* tid - A pointer to created thread.
Exceptions:
| Exception | Description |
| SwigException |
This command concatenates a list of Frame objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatFrameList ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD Frame objects in the C++ layer. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_frame | The container objects contain a frame data type other than Frame. |
| not_frame_data | The container objects are not frame data. |
| incompatible_frames | The container objects do not contain the same type. |
| incompatible_frame | The containers contain Frame data, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| bad_frame | The container object contains a frame data, but this data malformed( such as specified data in the object is missing, or element of the object is empty ). |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | Frame element specified by "element" has different type from expected. |
| invalid_format: "element" not found | Frame is missing "element". |
| invalid_format | Frame data is malformed. |
| SwigException |
This command concatenates a list of Frame objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatFrameList_r tid]
Parameters:
| Name | Type | Description |
| tid | tid* | A pointer to a concatFrameList thread. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_frame | The container objects contain a frame data type other than Frame. |
| not_frame_data | The container objects are not frame data. |
| incompatible_frames | The container objects do not contain the same type. |
| incompatible_frame | The containers contain Frame data, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| bad_frame | The container object contains a frame data, but this data malformed( such as specified data in the object is missing, or element of the object is empty ). |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | Frame element specified by "element" has different type from expected. |
| invalid_format: "element" not found | Frame is missing "element". |
| invalid_format | Frame data is malformed. |
| SwigException |
This command concatenates a list of Frame objects, creating a new object in the process.
Usage - Basic SWIG interface:
set tid [concatFrameList_t ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer *> & | A pointer to a NULL terminated array of ILWD Frame objects in the C++ layer. |
Return value:
tid* tid - A pointer to created thread.
Exceptions:
| Exception | Description |
| SwigException |
This command concatenates a list of ProcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatProcDataList ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD ProcData objects in the C++ layer. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_procdata | The container objects contain a frame data type other than ProcData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_procdata | The containers contain procdata but it is malformed. |
| incompatible_channels | The containers contain ProcData but they are for different channels. |
| incompatible_proc_samplerate | The containers contain ProcData but the sample rate is different. |
| incompatible_proc_fshift | The containers contain ProcData but the frequency shift is different. |
| unsupported_data | The containers contain ProcData but one or more of them containe either more than one data vector or a |
| multi | dimensional data vector. |
| incompatible_procdata | The containers contain ProcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incomplete_procdata | The containers contain ProcData, however the data in the first container does not run until the end of the frame. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | ProcData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | ProcData is missing "element". |
| invalid_format | ProcData is malformed. |
| SwigException |
This command concatenates a list of ProcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatProcDataList_r tid]
Parameters:
| Name | Type | Description |
| tid | tid* | A pointer to a concatProcDataList thread. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_procdata | The container objects contain a frame data type other than ProcData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_procdata | The containers contain procdata but it is malformed. |
| incompatible_channels | The containers contain ProcData but they are for different channels. |
| incompatible_proc_samplerate | The containers contain ProcData but the sample rate is different. |
| incompatible_proc_fshift | The containers contain ProcData but the frequency shift is different. |
| unsupported_data | The containers contain ProcData but one or more of them containe either more than one data vector or a multi-dimensional data vector. |
| incompatible_procdata | The containers contain ProcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incomplete_procdata | The containers contain ProcData, however the datain the first container does not run until the end of the frame. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | ProcData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | ProcData is missing "element". |
| invalid_format | ProcData is malformed. |
| SwigException |
This command concatenates a list of ProcData objects, creating a new object in the process.
Usage - Basic SWIG interface:
set tid [concatProcDataList_t ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD ProcData objects in the C++ layer. |
Return value:
tid* tid - A pointer to created thread.
Exceptions:
| Exception | Description |
| SwigException |
This command concatenates a list of SerData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatSerDataList ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD SerData objects in the C++ layer. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_serdata | The container objects contain a frame data type other than SerData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_serdata | The containers contain SerData but it is malformed. |
| incompatible_channels | The containers contain SerData but they are for different channels. |
| incompatible_ser_time | The containers contain SerData but the time is different. |
| incompatible_ser_samplerate | The containers contain SerData but the sample rate is different. |
| unsupported_data | The containers contain SerData but one or more of them contain either more than one data vector or a multi-dimensional data vector. |
| incompatible_serdata | The containers contain SerData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incompatible_ser_data | The containers contain SerData but the data is different. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | SerData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | SerData is missing "element". |
| invalid_format | SerData is malformed. |
| SwigException |
This command concatenates a list of SerData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatSerDataList_r tid]
Parameters:
| Name | Type | Description |
| tid | tid* | A pointer to a concatSerDataList thread |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_serdata | The container objects contain a frame data type other than SerData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_serdata | The containers contain SerData but it is malformed. |
| incompatible_channels | The containers contain SerData but they are for different channels. |
| incompatible_ser_time | The containers contain SerData but the time is different. |
| incompatible_ser_samplerate | The containers contain SerData but the sample rate is different. |
| unsupported_data | The containers contain SerData but one or more of them contain either more than one data vector or a multi-dimensional data vector. |
| incompatible_serdata | The containers contain SerData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| incompatible_ser_data | The containers contain SerData but the data is different. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | SerData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | SerData is missing "element". |
| invalid_format | SerData is malformed. |
| SwigException |
This command concatenates a list of SerData objects, creating a new object in the process.
Usage - Basic SWIG interface:
set tid [concatSerDataList_t ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD SerData objects in the C++ layer. |
Return value:
tid* tid - A pointer to created thread.
Exceptions:
| Exception | Description |
| SwigException |
This command concatenates a list of SimData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatSimDataList ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD SimData objects in the C++ layer. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_simdata | The container objects contain a frame data type other than SimData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_simdata | The containers contain SimData but it is malformed. |
| incompatible_channels | The containers contain SimData but they are for different channels. |
| incompatible_sim_samplerate | The containers contain SimData but the sample rate is different. |
| unsupported_data | The containers contain SimData but one or more of them contain either more than one data vector or a multi-dimensional data vector. |
| incompatible_simdata | The containers contain SimData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | SimData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | SimData is missing "element". |
| invalid_format | SimData is malformed. |
| SwigException |
This command concatenates a list of SimData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.
Usage - Basic SWIG interface:
set ptResult [concatSimDataList_r tid]
Parameters:
| Name | Type | Description |
| tid | tid* | A pointer to a concatSimDataList thread. |
Return value:
LdasContainer* ptResult - The concatenated object.
Exceptions:
| Exception | Description |
| invalid_ilwd_element | A pointer to the ILWD element is invalid. |
| invalid_container | One or both of the container objects don't exist. |
| invalid_frame_object | One or both of the container objects do not contain a frame object. |
| not_simdata | The container objects contain a frame data type other than SimData. |
| not_frame_data | The container objects are not frame data. |
| incompatible_types | The container objects do not contain the same type. |
| bad_simdata | The containers contain SimData but it is malformed. |
| incompatible_channels | The containers contain SimData but they are for different channels. |
| incompatible_sim_samplerate | The containers contain SimData but the sample rate is different. |
| unsupported_data | The containers contain SimData but one or more of them contain either more than one data vector or a multi-dimensional data vector. |
| incompatible_simdata | The containers contain SimData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container. |
| memory_allocation_failed | Error allocating memory. |
| invalid_format: "element" is unexpected type | SimData element specified by "element" has different type from expected. |
| invalid_format: "element" not found | SimData is missing "element". |
| invalid_format | SimData is malformed. |
| SwigException |
This command concatenates a list of SimData objects, creating a new object in the process.
Usage - Basic SWIG interface:
set tid [concatSimDataList_t ptObjArray]
Parameters:
| Name | Type | Description |
| ptObjArray | vector<LdasContainer*> & | A pointer to a NULL terminated array of ILWD SimData objects in the C++ layer. |
Return value:
tid* tid - A pointer to created thread.
Exceptions:
| Exception | Description |
| SwigException |
This function creates new ILWD container object that represents FrameCPP detector structure. Detector metadata is passed as function arguments.
Parameters:
| Name | Type | Description |
| name | const char* | Detector name. |
| longitude | double | Detector vertex longitude, degrees. |
| latitude | double | Detector vertex lattitude, degrees. |
| elevation | float | Vertex elevation, meters. |
| armXazimuth | float | Orientation of X arm. |
| armYazimuth | float | Orientation of Y arm. |
| armXaltitude | float | Altitude of X arm. |
| armYaltitude | float | Altitude of Y arm. |
| armXmidpoint | float | Midpoint of X arm. |
| armYmidpoint | float | Midpoint of Y arm. |
| localTime | int | local time offset. |
| dataQuality | unsigned int | data quality word. |
| qaBitList | const char* | data quality word definition list. |
Return value:
LdasContainer* - A pointer to newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
Usage - Basic SWIG interface:
set ptContainer [ createFrame name run frame gtimes gtimen uleaps dt]
Parameters:
| Name | Type | Description |
| name | const char* | The name for the frame. |
| run | unsigned int | The run number. |
| frame | unsigned int | The frame number. |
| gtimes | unsigned int | The GPS start time of the frame in seconds. |
| gtimen | unsigned int | The residual nanoseconds to the GPS start time. |
| uleaps | unsigned short | The integer number of leap seconds between GPS/TAI and UTC. |
| dt | double | The frame length in seconds. |
Return value:
LdasContainer* ptContainer - A pointer to the newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
This function creates new ILWD container object that represents FrameCPP History structure. History metadata is passed as function arguments.
Usage - Basic SWIG interface:
set ptContainer [ createHistory name time comment ]
Parameters:
| Name | Type | Description |
| name | const char* | Name of the history record. |
| time | unsigned int | Time of post-processing. GPS time in integer seconds since GPS standard epoch. |
| comment | const char* | Program name and relevant comments needed to define post-processing. |
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
This function creates new ILWD container object that represents FrameCPP Msg structure. Msg metadata is passed as function arguments.
Usage - Basic SWIG interface:
set ptContainer [ createMsg alarm message severity ]
Parameters:
| Name | Type | Description |
| alarm | const char* | The name of the message, error flag or alarm state. |
| message | const char* | The message body. |
| severity | unsigned int | An integer indicating the message severity level. |
| gtimes | unsigned int | GPS time seconds. |
| gtimen | unsigned int | GPS time nanosecond residual. |
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.
Usage - Basic SWIG interface:
set ptContainer [ createOuterDetectorProcContainer ]
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.
Usage - Basic SWIG interface:
set ptContainer [ createOuterDetectorSimContainer ]
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.
Usage - Basic SWIG interface:
set ptContainer [ createOuterHistoryContainer ]
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
This function creates new ILWD container object that represents FrameCPP FrProc structure. ProcData metadata is passed as function arguments.
Parameters:
| Name | Type | Description |
| name | const char* | The name for the ProcData. |
| comment | const char* | Comment. |
| sampleRate | double | sampling rate. |
| timeOffsetS | int | time offset second. |
| timeOffsetN | int | time offset nanoseconds. |
| fShift | double | frequency shift. |
| phase | double | phase of heterodyning signal. |
| gtimes | The GPS start time of the target frame in seconds. | |
| gtimen | The residual nanoseconds to the GPS start time. | |
| dt | The target frame's length in seconds. |
Return value:
LdasContainer* - A pointer to newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
This function creates new ILWD container object that represents FrameCPP RawData structure.
Usage - Basic SWIG interface:
set ptContainer [ createRawData name ]
Parameters:
| Name | Type | Description |
| name | const char* | Name of the raw data. |
Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.
Exceptions:
| Exception | Description |
| SwigException | |
| bad_alloc | Memory allocation failed. |
This function creates an empty frame. It copies the header, detector information and history data from passed to it frame.
Usage - Basic SWIG interface:
set ptFrame [createRawFrame ptSourceFrame]
Parameters:
| Name | Type | Description |
| ptSourceFrame | FrameH* | Frame object pointer. |
Return value:
FrameH* ptFrame - Newly created raw frame object.
Exceptions:
| Exception | Description |
| bad_alloc | Memory allocation failed. |
Usage - Basic SWIG interface:
set resampleState [ createResampleState q adcPtr ]
Parameters:
| Name | Type | Description |
| q | downsampling factor | |