hlcc::eltpk::GuideStarHelper Class Reference

#include <guideStarHelper.hpp>

Classes
struct	GuideStarItemData
struct	GuideStarMetadata
struct	GuideStars
struct	ParamMetadata

Public Member Functions
	GuideStarHelper ()
virtual	~GuideStarHelper ()
void	InitGuideStarConfigYaml ()
void	AddGuideStar (const ::ccsinsif::GuideStarData &guide_star_data)
std::string	GetGuideStarConfigYaml ()

Static Public Member Functions
static GuideStars	FromYamlToGuideStars (const std::string &yaml_guide_starts)

Detailed Description

This class implement methods that will help build a Config-ng Yaml config file containing guide start data and also the reverse operation where data is retrieved from Yaml to a single C++ object.

Constructor & Destructor Documentation

GuideStarHelper()

hlcc::eltpk::GuideStarHelper::GuideStarHelper

(

)

Constructor.

~GuideStarHelper()

hlcc::eltpk::GuideStarHelper::~GuideStarHelper ( )

virtual

Destructor

Member Function Documentation

AddGuideStar()

void hlcc::eltpk::GuideStarHelper::AddGuideStar

(

const ::ccsinsif::GuideStarData &

guide_star_data

)

Adds Guide star item data to the yaml configuration file

Parameters

[in]

guide_star_data

data to be appended

FromYamlToGuideStars()

GuideStarHelper::GuideStars hlcc::eltpk::GuideStarHelper::FromYamlToGuideStars ( const std::string & yaml_guide_starts )

static

Static Method used to convert the guidestart data from Yaml string to single c++ object

Parameters

[in]

yaml_guide_starts

String containing Yaml config-ng with guide star content

Returns

GuideStars object with values converted from the given Yaml

Exceptions

std::runtime_error

if cannot convert Yaml content

GetGuideStarConfigYaml()

std::string hlcc::eltpk::GuideStarHelper::GetGuideStarConfigYaml

(

)

Get the Yaml sting with complete Guide Star configuration

Returns

string containing the complete Guide Star Yaml configuration

InitGuideStarConfigYaml()

void hlcc::eltpk::GuideStarHelper::InitGuideStarConfigYaml

(

)

Initializes the Yaml string with the respective data typedefs

---

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

• /home/abuild/rpmbuild/BUILD/hlcc-v2.2.0/software/apps/eltpk/app/src/include/eltpk/guideStarHelper.hpp
• /home/abuild/rpmbuild/BUILD/hlcc-v2.2.0/software/apps/eltpk/app/src/guideStarHelper.cpp