WSF
WsfTSPI::Element Class Reference

A single TSPI element (time, lat, heading, etc.). More...

#include <WsfTSPI.hpp>

Public Member Functions

 Element ()=default
 Element (double aValue, unsigned int aValueType)
 ~Element ()=default
double operator() () const
 Return the value of the element.
Elementoperator= (const double aRhs)
 Set the value of the element.
double Get () const
 Return the value of the element.
void Set (double aAttribute)
 Set the value of the element.
void SetPersistentUnits (const std::string &aConversion)
 Set the persistent units (i.e., the units in which the value is saved.
void SetInverted (bool aIsInverted)
 Set whether the value of the element is to be inverted (i.e., negated).

Friends

std::ostream & operator<< (std::ostream &aStream, const Element &aTSPI)
 Stream out operator (typically, to a file); units are converted on output.
std::istream & operator>> (std::istream &aStream, WsfTSPI::Element &aElement)
 Stream in operator (typically, from a file); units are converted on input.

Detailed Description

A single TSPI element (time, lat, heading, etc.).

Constructor & Destructor Documentation

◆ Element() [1/2]

WsfTSPI::Element::Element ( )
default

References Element().

Referenced by Element(), and operator=().

◆ Element() [2/2]

WsfTSPI::Element::Element ( double aValue,
unsigned int aValueType )

◆ ~Element()

WsfTSPI::Element::~Element ( )
default

Member Function Documentation

◆ Get()

double WsfTSPI::Element::Get ( ) const
inline

Return the value of the element.

◆ operator()()

double WsfTSPI::Element::operator() ( ) const
inline

Return the value of the element.

◆ operator=()

Element & WsfTSPI::Element::operator= ( const double aRhs)
inline

Set the value of the element.

References Element().

◆ Set()

void WsfTSPI::Element::Set ( double aAttribute)
inline

Set the value of the element.

◆ SetInverted()

void WsfTSPI::Element::SetInverted ( bool aIsInverted)
inline

Set whether the value of the element is to be inverted (i.e., negated).

Referenced by WsfTSPI::ProcessInput().

◆ SetPersistentUnits()

void WsfTSPI::Element::SetPersistentUnits ( const std::string & aConversion)

Set the persistent units (i.e., the units in which the value is saved.

Assign the persistent units (i.e., the units in which the value is saved).

Referenced by WsfTSPI::ProcessInput().

◆ operator<<

std::ostream & operator<< ( std::ostream & aStream,
const Element & aTSPI )
friend

Stream out operator (typically, to a file); units are converted on output.

◆ operator>>

std::istream & operator>> ( std::istream & aStream,
WsfTSPI::Element & aElement )
friend

Stream in operator (typically, from a file); units are converted on input.


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved