Svc::AMPCSSequence Class Reference

A sequence in AMPCS format. More...

#include <Svc/CmdSequencer/formats/AMPCSSequence.hpp>

Inheritance diagram for Svc::AMPCSSequence:

Classes
struct	Record
	AMPCS sequence record. More...
struct	SequenceHeader
	AMPCS sequence header. More...

Public Member Functions
	AMPCSSequence (CmdSequencerComponentImpl &component)
	Construct an AMPCSSequence. More...
bool	loadFile (const Fw::StringBase &fileName)
bool	hasMoreRecords () const
void	nextRecord (Sequence::Record &record)
void	reset ()
void	clear ()
Public Member Functions inherited from Svc::CmdSequencerComponentImpl::Sequence
	Sequence (CmdSequencerComponentImpl &component)
	Construct a Sequence object. More...
virtual	~Sequence ()
	Destroy a Sequence object. More...
void	allocateBuffer (NATIVE_INT_TYPE identifier, Fw::MemAllocator &allocator, NATIVE_UINT_TYPE bytes)
	Give the sequence representation a memory buffer. More...
void	deallocateBuffer (Fw::MemAllocator &allocator)
	Deallocate the buffer. More...
void	setFileName (const Fw::StringBase &fileName)
	Set the file name. Also sets the log file name. More...
Fw::CmdStringArg &	getFileName ()
Fw::LogStringArg &	getLogFileName ()
const Header &	getHeader () const
	Get the sequence header. More...
virtual void	nextRecord (Record &record)=0

Additional Inherited Members
Protected Attributes inherited from Svc::CmdSequencerComponentImpl::Sequence
CmdSequencerComponentImpl &	m_component
	The enclosing component. More...
Events	m_events
	Event reporting. More...
Fw::CmdStringArg	m_fileName
	The sequence file name. More...
Fw::LogStringArg	m_logFileName
	Copy of file name for events. More...
Fw::ExternalSerializeBuffer	m_buffer
	Serialize buffer to hold the binary sequence data. More...
NATIVE_INT_TYPE	m_allocatorId
	The allocator ID. More...
Header	m_header
	The sequence header. More...

Detailed Description

A sequence in AMPCS format.

Definition at line 22 of file AMPCSSequence.hpp.

Constructor & Destructor Documentation

AMPCSSequence()

Svc::AMPCSSequence::AMPCSSequence

(

CmdSequencerComponentImpl &

component

)

Construct an AMPCSSequence.

Parameters

component

The enclosing component

Definition at line 22 of file AMPCSSequence.cpp.

Member Function Documentation

clear()

void Svc::AMPCSSequence::clear ( )

virtual

Clear the sequence records. After calling this, hasMoreRecords should return false.

Implements Svc::CmdSequencerComponentImpl::Sequence.

Definition at line 190 of file AMPCSSequence.cpp.

hasMoreRecords()

bool Svc::AMPCSSequence::hasMoreRecords ( ) const

virtual

Query whether the sequence has any more records

Returns

Yes or no

Implements Svc::CmdSequencerComponentImpl::Sequence.

Definition at line 171 of file AMPCSSequence.cpp.

loadFile()

bool Svc::AMPCSSequence::loadFile ( const Fw::StringBase &  fileName )

virtual

Load a sequence file

Returns

Success or failure

Parameters

fileName

The file name

Implements Svc::CmdSequencerComponentImpl::Sequence.

Definition at line 29 of file AMPCSSequence.cpp.

nextRecord()

void Svc::AMPCSSequence::nextRecord

(

Sequence::Record &

record

)

Get the next record in the sequence. Asserts on failure

Parameters

record

The returned record

Definition at line 177 of file AMPCSSequence.cpp.

reset()

void Svc::AMPCSSequence::reset ( )

virtual

Reset the sequence to the beginning. After calling this, hasMoreRecords should return true, unless the sequence has no records.

Implements Svc::CmdSequencerComponentImpl::Sequence.

Definition at line 184 of file AMPCSSequence.cpp.

---

The documentation for this class was generated from the following files:

• Svc/CmdSequencer/formats/AMPCSSequence.hpp
• Svc/CmdSequencer/formats/AMPCSSequence.cpp