Indexed elements of the FrEvent structure.
More...
#include <FrTOCEvent.hh>
|
| FrTOCEvent () |
| Default constructor.
|
|
Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
const nameEvent_container_type & | GetEvent () const |
| Return all events.
|
|
void | QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position) |
| Gather TOC info for FrEvent being written.
|
|
const FrTOCEvent & | operator= (const Previous::FrTOCEvent &Source) |
| asignment operator
|
|
bool | operator== (const FrTOCEvent &RHS) const |
| equality operator
|
|
| FrTOCEvent () |
| Default constructor.
|
|
Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
const nameEvent_container_type & | GetEvent () const |
| Return all events.
|
|
void | QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position) |
| Gather TOC info for FrEvent being written.
|
|
const FrTOCEvent & | operator= (const Previous::FrTOCEvent &Source) |
| asignment operator
|
|
bool | operator== (const FrTOCEvent &RHS) const |
| equality operator
|
|
|
template<typename SE > |
static void | Description (Common::Description &Desc) |
| The description of structure.
|
|
template<typename SE > |
static void | Description (Common::Description &Desc) |
| The description of structure.
|
|
|
| FrTOCEvent (Common::IStream &Stream) |
| Stream constructor.
|
|
positionEvent_type | positionEvent (INT_4U Frame, const std::string &Event) const |
| Locate the position of the event.
|
|
positionEvent_type | positionEvent (const std::string &Event, INT_4U Index) const |
| Locate the position of the event.
|
|
void | write (Common::OStream &Stream) const |
| Write the structure to the stream.
|
|
| FrTOCEvent (Common::IStream &Stream) |
| Stream constructor.
|
|
positionEvent_type | positionEvent (INT_4U Frame, const std::string &Event) const |
| Locate the position of the event.
|
|
positionEvent_type | positionEvent (const std::string &Event, INT_4U Index) const |
| Locate the position of the event.
|
|
void | write (Common::OStream &Stream) const |
| Write the structure to the stream.
|
|
Indexed elements of the FrEvent structure.
◆ FrTOCEvent() [1/2]
FrameCPP::Version_8::FrTOCEvent::FrTOCEvent |
( |
Common::IStream & | Stream | ) |
|
|
protected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ FrTOCEvent() [2/2]
FrameCPP::Version_8::FrTOCEvent::FrTOCEvent |
( |
Common::IStream & | Stream | ) |
|
|
protected |
Stream constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ Bytes() [1/2]
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCEvent::Bytes |
( |
const Common::StreamBase & | Stream | ) |
const |
|
inline |
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]
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCEvent::Bytes |
( |
const Common::StreamBase & | Stream | ) |
const |
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]
template<typename SE >
void FrameCPP::Version_8::FrTOCEvent::Description |
( |
Common::Description & | Desc | ) |
|
|
static |
The description of structure.
- Parameters
-
[out] | Desc | Storage for the description of the structure. |
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ Description() [2/2]
template<typename SE >
static void FrameCPP::Version_8::FrTOCEvent::Description |
( |
Common::Description & | Desc | ) |
|
|
static |
The description of structure.
- Parameters
-
[out] | Desc | Storage for the description of the structure. |
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ GetEvent() [1/2]
const FrTOCEvent::nameEvent_container_type & FrameCPP::Version_8::FrTOCEvent::GetEvent |
( |
| ) |
const |
|
inline |
Return all events.
- Returns
- Constant container to the indexed FrEvent elements.
◆ GetEvent() [2/2]
const nameEvent_container_type & FrameCPP::Version_8::FrTOCEvent::GetEvent |
( |
| ) |
const |
Return all events.
- Returns
- Constant container to the indexed FrEvent elements.
◆ operator=() [1/2]
const FrTOCEvent & FrameCPP::Version_8::FrTOCEvent::operator= |
( |
const Previous::FrTOCEvent & | Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator=() [2/2]
const FrTOCEvent & FrameCPP::Version_8::FrTOCEvent::operator= |
( |
const Previous::FrTOCEvent & | Source | ) |
|
asignment operator
- Parameters
-
[in] | Source | The source to be copied. |
◆ operator==() [1/2]
bool FrameCPP::Version_8::FrTOCEvent::operator== |
( |
const FrTOCEvent & | 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::FrTOCEvent::operator== |
( |
const FrTOCEvent & | RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ positionEvent() [1/4]
FrTOCEvent::positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent |
( |
const std::string & | Event, |
|
|
INT_4U | Index ) const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | Event | The name of the event. |
[in] | Index | Offset of the event. |
- Returns
- The file position of the requested event.
◆ positionEvent() [2/4]
positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent |
( |
const std::string & | Event, |
|
|
INT_4U | Index ) const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | Event | The name of the event. |
[in] | Index | Offset of the event. |
- Returns
- The file position of the requested event.
◆ positionEvent() [3/4]
FrTOCEvent::positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent |
( |
INT_4U | Frame, |
|
|
const std::string & | Event ) const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | Frame | Frame offset of the event. |
[in] | Event | The name of the event. |
- Returns
- The file position of the requested event.
◆ positionEvent() [4/4]
positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent |
( |
INT_4U | Frame, |
|
|
const std::string & | Event ) const |
|
protected |
Locate the position of the event.
- Parameters
-
[in] | Frame | Frame offset of the event. |
[in] | Event | The name of the event. |
- Returns
- The file position of the requested event.
◆ QueryEvent() [1/2]
void FrameCPP::Version_8::FrTOCEvent::QueryEvent |
( |
const Common::TOCInfo & | Info, |
|
|
INT_4U | FrameOffset, |
|
|
INT_8U | Position ) |
Gather TOC info for FrEvent 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. |
◆ QueryEvent() [2/2]
void FrameCPP::Version_8::FrTOCEvent::QueryEvent |
( |
const Common::TOCInfo & | Info, |
|
|
INT_4U | FrameOffset, |
|
|
INT_8U | Position ) |
Gather TOC info for FrEvent 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::FrTOCEvent::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::FrTOCEvent::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. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrTOCEvent.hh
- Version8/FrTOCEvent.hh
- Version8/FrTOCEvent.cc