usmtf::InputBlock Class Reference

#include <InputBlock.hpp>

Public Member Functions
	InputBlock (const std::string &aHeader, const std::string &aName, const bool aExcludeFooter=false, const bool aIgnoreNesting=false)
void	AddProperty (const InputBlockProperty &aProp) noexcept
	Add an attribute to a block.
void	AddBlock (const InputBlock &aBlock) noexcept
	Add a nested block.
const std::string	GetBlock (unsigned nesting=0) const noexcept
	Return the constructed string complete with nesting space.
const std::vector< InputBlockProperty > &	GetProperties () const noexcept
	Grab the vector of input properties.

Detailed Description

An Input Block is a class used to abstract away the export of entities and attributes describing those entities in the shapes that AFSIM Scenarios files need.

A Block can be flat or contain nested blocks. They always construct properties first then nested blocks second, recursively.

      ______     header
      |              properties <---- n Properties
      |              blocks                 __________

Input | – properties | Block | – blocks | Nested Input block | – etc | | – etc.. n times __________| |_____ end_header

Constructor & Destructor Documentation

InputBlock()

usmtf::InputBlock::InputBlock	(	const std::string &	aHeader,
		const std::string &	aName,
		const bool	aExcludeFooter = false,
		const bool	aIgnoreNesting = false )

Referenced by AddBlock().

Member Function Documentation

AddBlock()

void usmtf::InputBlock::AddBlock ( const InputBlock & aBlock )

noexcept

Add a nested block.

References InputBlock().

Referenced by usmtf::Zone::AddAmplificationBlockIfPresent(), usmtf::AircraftMissionTransform::GetInputBlock(), usmtf::AOrbitZone::GetInputBlock(), usmtf::OneTrackZone::GetInputBlock(), and usmtf::PolyarcZone::GetInputBlock().

AddProperty()

void usmtf::InputBlock::AddProperty ( const InputBlockProperty & aProp )

noexcept

Add an attribute to a block.

Referenced by usmtf::Zone::AddAmplificationBlockIfPresent(), usmtf::ExportAto(), usmtf::AOrbitZone::GetInputBlock(), usmtf::Comment::GetInputBlock(), usmtf::Macro::GetInputBlock(), usmtf::OneTrackZone::GetInputBlock(), usmtf::Platform::GetInputBlock(), and usmtf::PolyarcZone::GetInputBlock().

GetBlock()

const std::string usmtf::InputBlock::GetBlock ( unsigned nesting = 0 ) const

noexcept

Return the constructed string complete with nesting space.

GetProperties()

const std::vector< InputBlockProperty > & usmtf::InputBlock::GetProperties ( ) const

noexcept

Grab the vector of input properties.

Referenced by usmtf::ExportAto().

---

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

• InputBlock.hpp
• InputBlock.cpp