LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::MilitarySymbology Class Referenceabstract

Encapsulates the symbol hierarchy of a symbology standard. More...

#include <luciad/symbology/military/MilitarySymbology.h>

Classes

class  Standards
 Allows enumerating Standard values and converting them to and from std::string. More...
 

Public Types

enum class  Standard {
  MilStd2525b , MilStd2525c , MilStd2525d , App6a ,
  App6b , App6c , App6d
}
 The supported symbology standards. More...
 

Public Member Functions

virtual ~MilitarySymbology ()=default
 
virtual std::vector< std::shared_ptr< MilitarySymbologyNode > > getAllSymbols () const =0
 Returns the list of symbols pertaining to this military symbology. More...
 
virtual std::string getName () const =0
 Returns the symbology's name. More...
 
virtual std::shared_ptr< MilitarySymbologyNodegetRootSymbolNode () const =0
 Returns the root node of the symbology hierarchy. More...
 
virtual Standard getStandard () const =0
 Returns the symbology's standard. More...
 
virtual std::shared_ptr< MilitarySymbologyNodegetSymbolNode (const std::string &code) const =0
 Returns the node corresponding to the given code in the symbology hierarchy, or nullptr if the given code is not present in this hierarchy. More...
 

Static Public Member Functions

static std::shared_ptr< MilitarySymbologyget (Standard standard)
 Returns the symbology for the given identifier. More...
 

Detailed Description

Encapsulates the symbol hierarchy of a symbology standard.

Member Enumeration Documentation

◆ Standard

The supported symbology standards.

See Standards to enumerate all values and convert them to and from std::string.

Enumerator
MilStd2525b 

Constant for MIL-STD 2525 revision B, change 2.

MilStd2525c 

Constant for MIL-STD 2525 revision C.

MilStd2525d 

Constant for MIL-STD 2525 revision D.

App6a 

Constant for APP 6 revision A.

App6b 

Constant for APP 6 revision B.

App6c 

Constant for APP 6 revision C.

App6d 

Constant for APP 6 revision D.

Constructor & Destructor Documentation

◆ ~MilitarySymbology()

virtual luciad::MilitarySymbology::~MilitarySymbology ( )
virtualdefault

Member Function Documentation

◆ get()

static std::shared_ptr< MilitarySymbology > luciad::MilitarySymbology::get ( Standard  standard)
static

Returns the symbology for the given identifier.

Parameters
standardthe symbology standard to load.
Returns
the symbology for the given identifier.

◆ getAllSymbols()

virtual std::vector< std::shared_ptr< MilitarySymbologyNode > > luciad::MilitarySymbology::getAllSymbols ( ) const
pure virtual

Returns the list of symbols pertaining to this military symbology.

Returns
the list of symbols pertaining to this military symbology

◆ getName()

virtual std::string luciad::MilitarySymbology::getName ( ) const
pure virtual

Returns the symbology's name.

Returns
the symbology's name.

◆ getRootSymbolNode()

virtual std::shared_ptr< MilitarySymbologyNode > luciad::MilitarySymbology::getRootSymbolNode ( ) const
pure virtual

Returns the root node of the symbology hierarchy.

Returns
the root node of the symbology hierarchy.

◆ getStandard()

virtual Standard luciad::MilitarySymbology::getStandard ( ) const
pure virtual

Returns the symbology's standard.

Returns
the symbology's standard

◆ getSymbolNode()

virtual std::shared_ptr< MilitarySymbologyNode > luciad::MilitarySymbology::getSymbolNode ( const std::string &  code) const
pure virtual

Returns the node corresponding to the given code in the symbology hierarchy, or nullptr if the given code is not present in this hierarchy.

Parameters
codethe code of the symbol.
Returns
the node corresponding to the given code in the symbology hierarchy, or nullptr if the given code is not present in this hierarchy.