ldas-tools-framecpp  2.8.1
Classes | Enumerations | Functions | Variables
FrameC Namespace Reference

Routines related to implementing the C interface. More...

Classes

class  Pointers
 
struct  Handle
 
struct  FrameH
 
struct  FrChannel
 
struct  FrDetector
 
struct  FrEvent
 
struct  FrHistory
 
struct  FrTOC
 

Enumerations

enum  pointer_type {
  POINTER_STREAM , POINTER_FR_CHANNEL , POINTER_FR_DETECTOR , POINTER_FR_EVENT ,
  POINTER_FR_HISTORY , POINTER_FRAME_H , POINTER_FR_TOC
}
 

Functions

void Set (FrameCError **Error)
 
void Set (FrameCError **Error, framec_errno_type Errno, const std::string &Message)
 
template<typename T >
pointer_type PointerType (T *)
 
void Set (FrameCError **Error, framec_errno_type Errno, const char *Message)
 
template<class H >
HandleCast (const void *Base)
 
template<class H >
HandleCast (void *Base)
 
template<>
pointer_type PointerType (FrameH *Value)
 
template<>
pointer_type PointerType (FrChannel *Value)
 
template<>
FrChannel::channel_t::fr_adc_data FrChannel::Channel< FrameCPP::FrAdcData > ()
 
template<>
FrChannel::channel_t::fr_event FrChannel::Channel< FrameCPP::FrEvent > ()
 
template<>
FrChannel::channel_t::fr_proc_data FrChannel::Channel< FrameCPP::FrProcData > ()
 
template<>
FrChannel::channel_t::fr_sim_data FrChannel::Channel< FrameCPP::FrSimData > ()
 
template<>
FrChannel::channel_t::fr_sim_event FrChannel::Channel< FrameCPP::FrSimEvent > ()
 
template<>
pointer_type PointerType (FrDetector *Value)
 
template<>
pointer_type PointerType (FrEvent *Value)
 
template<>
pointer_type PointerType (FrHistory *Value)
 
template<>
pointer_type PointerType (FrTOC *Value)
 
template<>
pointer_type PointerType (fr_file_t *Value)
 
FrameCPP::IFrameStreamStreamAsInput (fr_file_t *Stream)
 
FrameCPP::OFrameStreamStreamAsOutput (fr_file_t *Stream)
 

Variables

const char * UnknownError = "Unknown error"
 

Detailed Description

Routines related to implementing the C interface.

The C Interface allows for C applications to interface with the C++ interface without having to use a C++ compiler.

Note
All exceptions are caught and translated into numeric error values.

Enumeration Type Documentation

◆ pointer_type

Enumerator
POINTER_STREAM 
POINTER_FR_CHANNEL 
POINTER_FR_DETECTOR 
POINTER_FR_EVENT 
POINTER_FR_HISTORY 
POINTER_FRAME_H 
POINTER_FR_TOC 

Function Documentation

◆ FrChannel::Channel< FrameCPP::FrAdcData >()

◆ FrChannel::Channel< FrameCPP::FrEvent >()

◆ FrChannel::Channel< FrameCPP::FrProcData >()

◆ FrChannel::Channel< FrameCPP::FrSimData >()

◆ FrChannel::Channel< FrameCPP::FrSimEvent >()

◆ HandleCast() [1/2]

template<class H >
H FrameC::HandleCast ( const void *  Base)

◆ HandleCast() [2/2]

template<class H >
H FrameC::HandleCast ( void *  Base)

◆ PointerType() [1/8]

template<>
pointer_type FrameC::PointerType ( fr_file_t Value)

◆ PointerType() [2/8]

template<>
pointer_type FrameC::PointerType ( FrameH Value)
inline

◆ PointerType() [3/8]

template<>
pointer_type FrameC::PointerType ( FrChannel Value)

◆ PointerType() [4/8]

template<>
pointer_type FrameC::PointerType ( FrDetector Value)
inline

◆ PointerType() [5/8]

template<>
pointer_type FrameC::PointerType ( FrEvent Value)
inline

◆ PointerType() [6/8]

template<>
pointer_type FrameC::PointerType ( FrHistory Value)
inline

◆ PointerType() [7/8]

template<>
pointer_type FrameC::PointerType ( FrTOC Value)
inline

◆ PointerType() [8/8]

template<typename T >
pointer_type FrameC::PointerType ( T *  )

◆ Set() [1/3]

void FrameC::Set ( FrameCError **  Error)
inline

◆ Set() [2/3]

void FrameC::Set ( FrameCError **  Error,
framec_errno_type  Errno,
const char *  Message 
)
inline

◆ Set() [3/3]

void FrameC::Set ( FrameCError **  Error,
framec_errno_type  Errno,
const std::string &  Message 
)
inline

◆ StreamAsInput()

FrameCPP::IFrameStream* FrameC::StreamAsInput ( fr_file_t Stream)
inline

◆ StreamAsOutput()

FrameCPP::OFrameStream* FrameC::StreamAsOutput ( fr_file_t Stream)
inline

Variable Documentation

◆ UnknownError

const char * FrameC::UnknownError = "Unknown error"