Indexed elements of the FrSimEvent structure.
More...
#include <FrTOCSimEvent.hh>
Indexed elements of the FrSimEvent structure.
◆ amplitudeSimEvent_type [1/2]
◆ amplitudeSimEvent_type [2/2]
◆ events_container_type [1/2]
◆ events_container_type [2/2]
◆ gtimenSim_type [1/2]
◆ gtimenSim_type [2/2]
◆ gtimesSim_type [1/2]
◆ gtimesSim_type [2/2]
◆ name_type [1/2]
◆ name_type [2/2]
◆ nameSimEvent_container_type [1/2]
◆ nameSimEvent_container_type [2/2]
◆ nevent_type [1/2]
◆ nevent_type [2/2]
◆ nTotalSEvent_type [1/2]
◆ nTotalSEvent_type [2/2]
◆ positionSimEvent_type [1/2]
◆ positionSimEvent_type [2/2]
◆ FrTOCSimEvent() [1/4]
FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent |
( |
| ) |
|
◆ FrTOCSimEvent() [2/4]
FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent |
( |
Common::IStream & |
Stream | ) |
|
|
protected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ FrTOCSimEvent() [3/4]
FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent |
( |
| ) |
|
◆ FrTOCSimEvent() [4/4]
FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent |
( |
Common::IStream & |
Stream | ) |
|
|
protected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ Bytes() [1/2]
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ Bytes() [2/2]
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ Description() [1/2]
The description of structure.
- Parameters
-
[out] | Desc | Storage for the description of the structure. |
- Returns
- A Descriptio nobject which describes this structure as specified by the frame specification.
◆ Description() [2/2]
The description of structure.
- Parameters
-
[out] | Desc | Storage for the description of the structure. |
- Returns
- A Descriptio nobject which describes this structure as specified by the frame specification.
◆ GetSimEvent() [1/2]
Return all events.
- Returns
- Constant container to the indexed FrSimEvent elements.
◆ GetSimEvent() [2/2]
Return all events.
- Returns
- Constant container to the indexed FrSimEvent elements.
◆ operator=() [1/2]
const FrTOCSimEvent & FrameCPP::Version_8::FrTOCSimEvent::operator= |
( |
const Previous::FrTOCSimEvent & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator=() [2/2]
const FrTOCSimEvent & FrameCPP::Version_8::FrTOCSimEvent::operator= |
( |
const Previous::FrTOCSimEvent & |
Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/2]
bool FrameCPP::Version_8::FrTOCSimEvent::operator== |
( |
const FrTOCSimEvent & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [2/2]
bool FrameCPP::Version_8::FrTOCSimEvent::operator== |
( |
const FrTOCSimEvent & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ positionSimEvent() [1/4]
Locate the position of the event.
- Parameters
-
[in] | EventType | The name of the event. |
[in] | Index | Offset of the event. |
- Returns
- The file position of the requested event.
◆ positionSimEvent() [2/4]
positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent |
( |
const std::string & |
EventType, |
|
|
INT_4U |
Index |
|
) |
| const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | EventType | The name of the event. |
[in] | Index | Offset of the event. |
- Returns
- The file position of the requested event.
◆ positionSimEvent() [3/4]
Locate the position of the event.
- Parameters
-
[in] | Frame | Frame offset of the event. |
[in] | SimEvent | The name of the event. |
- Returns
- The file position of the requested event.
◆ positionSimEvent() [4/4]
positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent |
( |
INT_4U |
Frame, |
|
|
const std::string & |
SimEvent |
|
) |
| const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | Frame | Frame offset of the event. |
[in] | SimEvent | The name of the event. |
- Returns
- The file position of the requested event.
◆ QuerySimEvent() [1/2]
void FrameCPP::Version_8::FrTOCSimEvent::QuerySimEvent |
( |
const Common::TOCInfo & |
Info, |
|
|
INT_4U |
FrameOffset, |
|
|
INT_8U |
Position |
|
) |
| |
Gather TOC info for FrSimEvent being written.
- Parameters
-
[in] | Info | Information |
[in] | FrameOffset | The frame offset of the frame being written. The frame offsets start at 0 (zero). |
[in] | Position | The byte offset from the start of the file where the structure is written. |
◆ QuerySimEvent() [2/2]
void FrameCPP::Version_8::FrTOCSimEvent::QuerySimEvent |
( |
const Common::TOCInfo & |
Info, |
|
|
INT_4U |
FrameOffset, |
|
|
INT_8U |
Position |
|
) |
| |
Gather TOC info for FrSimEvent being written.
- Parameters
-
[in] | Info | Information |
[in] | FrameOffset | The frame offset of the frame being written. The frame offsets start at 0 (zero). |
[in] | Position | The byte offset from the start of the file where the structure is written. |
◆ write() [1/2]
void FrameCPP::Version_8::FrTOCSimEvent::write |
( |
Common::OStream & |
Stream | ) |
const |
|
protected |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ write() [2/2]
void FrameCPP::Version_8::FrTOCSimEvent::write |
( |
Common::OStream & |
Stream | ) |
const |
|
protected |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ event_type_size
static const int FrameCPP::Version_8::FrTOCSimEvent::event_type_size |
|
static |
Initial value:
REAL_4 amplitudeSimEvent_type
Definition: FrTOCSimEvent.hh:60
INT_8U positionSimEvent_type
Definition: FrTOCSimEvent.hh:61
INT_4U gtimesSim_type
Definition: FrTOCSimEvent.hh:58
INT_4U gtimenSim_type
Definition: FrTOCSimEvent.hh:59
◆ m_info
The documentation for this class was generated from the following files: