ExampleShmPubScao Class Reference

Inheritance diagram for ExampleShmPubScao:

Public Member Functions
	ExampleShmPubScao (int argc, char *argv[])
std::vector< ScaoLoopTopic >	ReadFits (std::string filename) override
	Reads in data from a FITS file.
std::vector< ScaoLoopTopic >	GenData (int num_frames) override
	Generates data to be circulated.
Public Member Functions inherited from rtctk::standaloneTools::ShmPub< ScaoLoopTopic >
	ShmPub (int argc, char *argv[])
virtual	~ShmPub ()=default
int	Run ()
	Entry point for running the ShmPub.
virtual void	AdjustSample (ScaoLoopTopic &sample) const
	Adjust the contents of a data sample just before publishing to shared memory.

Additional Inherited Members
Protected Member Functions inherited from rtctk::standaloneTools::ShmPub< ScaoLoopTopic >
std::string	GetQueueName () const
	Returns the shared memory queue name argument set on the command line.
size_t	GetQueueSize () const
	Returns the shared memory queue size argument set on the command line.
int	GetSampleDelay () const
	Returns the sample delay argument set on the command line.
int	GetNuma () const
	Returns the NUMA node argument set on the command line.
bool	GetRepeatMode () const
	Returns the repeat mode flag set on the command line.

Constructor & Destructor Documentation

ExampleShmPubScao()

ExampleShmPubScao::ExampleShmPubScao ( int argc, char * argv[] )

inline

Member Function Documentation

GenData()

std::vector< ScaoLoopTopic > ExampleShmPubScao::GenData ( int num_frames )

inlineoverridevirtual

Generates data to be circulated.

This is a pure virtual function that must be overloaded by a child class in user code. The user code must allocate the necessary vector of the appropriate size (typically num_frames), fill the vector with generated data, and then return the vector.

If an exception is thrown from this method the process will terminate early with an error message.

Parameters

num_frames

The number of frames for which to generate data.

Returns

A vector of data points of type TopicType, i.e. std::vector<TopicType>. The size of the vector should typically be equal to num_frames.

Implements rtctk::standaloneTools::ShmPub< ScaoLoopTopic >.

ReadFits()

std::vector< ScaoLoopTopic > ExampleShmPubScao::ReadFits ( std::string filename )

inlineoverridevirtual

Reads in data from a FITS file.

This is a pure virtual function that must be overloaded by a child class in user code. The user code must allocate the necessary vector of the appropriate size, perform all FITS file access and handling, and return the filled vector containing the data.

If an exception is thrown from this method the process will terminate early with an error message.

Parameters

filename

The name of the FITS file to read from.

Returns

A vector of data points of type TopicType, i.e. std::vector<TopicType>.

Implements rtctk::standaloneTools::ShmPub< ScaoLoopTopic >.

---

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

• _examples/exampleDataTask/common/shmPub/src/main.cpp