RTC Toolkit  2.0.0
Public Member Functions | List of all members
ExampleShmPubScao Class Reference
Inheritance diagram for ExampleShmPubScao:
rtctk::standaloneTools::ShmPub< ScaoLoopTopic >

Public Member Functions

 ExampleShmPubScao (int argc, char *argv[])
 
std::vector< ScaoLoopTopicReadFits (std::string filename) override
 Reads in data from a FITS file. More...
 
std::vector< ScaoLoopTopicGenData (int num_frames) override
 Generates data to be circulated. More...
 
- 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. More...
 

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_framesThe 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
filenameThe 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: