Detailed Description

The TSLAPP6ASymbol class acts as a container for all the possible modifiers and symbol configuration parameters. It works in conjunction with the TSLAPP6AHelper class. Typically you should set up the required properties here, before calling TSLAPP6AHelper::getSymbolAsEntitySet(), which can be displayed on the map surface.

This class also allows symbols to be read from and written to strings and streams.

Public Types
enum	UnitSizeEnum { UnitSizeNone , UnitSizeTeamCrew , UnitSizeSquad , UnitSizeSection , UnitSizePlatoon , UnitSizeCompany , UnitSizeBattalion , UnitSizeRegimentGroup , UnitSizeBrigade , UnitSizeDivision , UnitSizeCorps , UnitSizeArmy , UnitSizeArmyGroup , UnitSizeRegion }

enum	MobilityEnum { MobilityNone , MobilityWheeledLimitedCrossCountry , MobilityWheeledCrossCountry , MobilityTracked , MobilityWheeledAndTracked , MobilityTowed , MobilityRailway , MobilityOverSnow , MobilitySled , MobilityPackAnimals , MobilityBarge , MobilityAmphibious }

enum	HostilityEnum { HostilityNone , HostilityPending , HostilityUnknown , HostilityAssumedFriend , HostilityFriend , HostilityNeutral , HostilitySuspect , HostilityHostile , HostilityJoker , HostilityFaker }

enum	TypeEnum { TypeNone , TypeAirSpace , TypeUnit , TypeEquipment , TypeSeaSurface , TypeSubSurface , TypeSpecialOperations , TypeInstallation , TypeHeader }

Public Member Functions
	TSLAPP6ASymbol ()

	TSLAPP6ASymbol (const TSLAPP6ASymbol &rhs)

	~TSLAPP6ASymbol ()

TSLAPP6ASymbol &	operator= (const TSLAPP6ASymbol &rhs)

bool	read (const char *symbol)

bool	write (TSLSimpleString &data)

bool	load (TSLifstream &stream)

bool	save (TSLofstream &stream)

void	additionalInformation (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	additionalInformation () const

void	altitudeOrDepth (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	altitudeOrDepth () const

void	C2HQName (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	C2HQName () const

void	combatEffectiveness (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	combatEffectiveness () const

void	dateAndTime (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	dateAndTime () const

void	designation (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	designation () const

void	equipmentType (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	equipmentType () const

void	evaluationRating (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	evaluationRating () const

void	higherFormation (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	higherFormation () const

void	hostileEnemy (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	hostileEnemy () const

void	IFFSIFValue (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	IFFSIFValue () const

void	latAndLong (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	latAndLong () const

void	name (const char *value)

const char *	name () const

void	planned (bool value)

bool	planned () const

void	quantity (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	quantity () const

void	signalEquipment (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	signalEquipment () const

void	speed (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	speed () const

void	staffComments (const char *value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_TEXT)

const char *	staffComments () const

void	id (const char *value)

const char *	id () const

void	hostility (TSLAPP6ASymbol::HostilityEnum value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_FRAME)

TSLAPP6ASymbol::HostilityEnum	hostility () const

void	mobility (TSLAPP6ASymbol::MobilityEnum value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

TSLAPP6ASymbol::MobilityEnum	mobility () const

void	unitSize (TSLAPP6ASymbol::UnitSizeEnum value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

TSLAPP6ASymbol::UnitSizeEnum	unitSize () const

void	type (TSLAPP6ASymbol::TypeEnum value)

TSLAPP6ASymbol::TypeEnum	type () const

bool	isFeintDummy () const

void	isFeintDummy (bool value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

int	key () const

void	key (int value)

bool	isHQStaff () const

void	isHQStaff (bool value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

bool	isReduced () const

void	isReduced (bool value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

bool	isReinforced () const

void	isReinforced (bool value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

bool	isTaskforce () const

void	isTaskforce (bool value, TSLFeatureID featureID=TSLAPP6A_DEFAULT_GRAPHIC)

double	height () const

void	height (double value)

TSLDimensionUnits	heightType () const

void	heightType (TSLDimensionUnits value)

TSLTMC	x () const

void	x (TSLTMC value)

TSLTMC	y () const

void	y (TSLTMC value)

int	depth () const

void	depth (int value)

bool	smallText () const

void	smallText (bool value)

int	textColour () const

void	textColour (int value)

bool	isFramed () const

void	isFramed (bool value)

bool	isFrameOptional () const

void	isFrameOptional (bool newValue)

Member Enumeration Documentation

◆ HostilityEnum

enum TSLAPP6ASymbol::HostilityEnum

The hostility enum value is used to set the hostility and therefore the frame type/colour for a particular symbol.

Enumerator
HostilityNone
HostilityPending
HostilityUnknown
HostilityAssumedFriend
HostilityFriend
HostilityNeutral
HostilitySuspect
HostilityHostile
HostilityJoker
HostilityFaker

◆ MobilityEnum

enum TSLAPP6ASymbol::MobilityEnum

The mobility enum value is used to set the mobility modifier for a particular symbol.

Note: Mobility modifiers are only applicable to equipment type symbols.

Enumerator
MobilityNone
MobilityWheeledLimitedCrossCountry
MobilityWheeledCrossCountry
MobilityTracked
MobilityWheeledAndTracked
MobilityTowed
MobilityRailway
MobilityOverSnow
MobilitySled
MobilityPackAnimals
MobilityBarge
MobilityAmphibious

◆ TypeEnum

enum TSLAPP6ASymbol::TypeEnum

The type enum is used to indicate the type of a particular symbol in the palette.

The type is usually set when the symbols are loaded from the config file. The TypeHeader value is used to indicate header values (e.g. 1.x.4) and therefore these symbols will not be shown in the Symbol Selector.

TypeInstallation symbols will automatically be displayed with a black installation indicator on their frames.

Enumerator
TypeNone
TypeAirSpace
TypeUnit
TypeEquipment
TypeSeaSurface
TypeSubSurface
TypeSpecialOperations
TypeInstallation
TypeHeader

◆ UnitSizeEnum

enum TSLAPP6ASymbol::UnitSizeEnum

The unit size enum is used to indicate the unit size of a particular symbol in the palette.

Enumerator
UnitSizeNone
UnitSizeTeamCrew
UnitSizeSquad
UnitSizeSection
UnitSizePlatoon
UnitSizeCompany
UnitSizeBattalion
UnitSizeRegimentGroup
UnitSizeBrigade
UnitSizeDivision
UnitSizeCorps
UnitSizeArmy
UnitSizeArmyGroup
UnitSizeRegion

Constructor & Destructor Documentation

◆ TSLAPP6ASymbol() [1/2]

TSLAPP6ASymbol::TSLAPP6ASymbol ( )

Default constructor.

◆ TSLAPP6ASymbol() [2/2]

TSLAPP6ASymbol::TSLAPP6ASymbol ( const TSLAPP6ASymbol & rhs )

Copy constructor.

◆ ~TSLAPP6ASymbol()

TSLAPP6ASymbol::~TSLAPP6ASymbol ( )

Destructor.

Member Function Documentation

◆ additionalInformation() [1/2]

const char * TSLAPP6ASymbol::additionalInformation ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ additionalInformation() [2/2]

void TSLAPP6ASymbol::additionalInformation	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ altitudeOrDepth() [1/2]

const char * TSLAPP6ASymbol::altitudeOrDepth ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ altitudeOrDepth() [2/2]

void TSLAPP6ASymbol::altitudeOrDepth	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ C2HQName() [1/2]

const char * TSLAPP6ASymbol::C2HQName ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ C2HQName() [2/2]

void TSLAPP6ASymbol::C2HQName	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ combatEffectiveness() [1/2]

const char * TSLAPP6ASymbol::combatEffectiveness ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ combatEffectiveness() [2/2]

void TSLAPP6ASymbol::combatEffectiveness	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ dateAndTime() [1/2]

const char * TSLAPP6ASymbol::dateAndTime ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ dateAndTime() [2/2]

void TSLAPP6ASymbol::dateAndTime	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ depth() [1/2]

int TSLAPP6ASymbol::depth ( ) const

Queries the depth of the symbol. The depth is deduced from the ID of the symbol. For example, a symbol with id 1.2 would have a depth of 0 and a symbol with id 1.2.3.1 would have a depth of 2.

Returns the integer depth of the symbol.

◆ depth() [2/2]

void TSLAPP6ASymbol::depth ( int value )

Sets the depth of the symbol.

Parameters

value The new depth.

◆ designation() [1/2]

const char * TSLAPP6ASymbol::designation ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ designation() [2/2]

void TSLAPP6ASymbol::designation	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ equipmentType() [1/2]

const char * TSLAPP6ASymbol::equipmentType ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ equipmentType() [2/2]

void TSLAPP6ASymbol::equipmentType	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ evaluationRating() [1/2]

const char * TSLAPP6ASymbol::evaluationRating ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ evaluationRating() [2/2]

void TSLAPP6ASymbol::evaluationRating	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ height() [1/2]

double TSLAPP6ASymbol::height ( ) const

Returns the current height of the symbol.

◆ height() [2/2]

void TSLAPP6ASymbol::height ( double value )

Sets the height of the symbol. This is not a symbol modifier, rather it is a configuration setting that tells the helper how large to make any entitysets containing the symbol.

◆ heightType() [1/2]

TSLDimensionUnits TSLAPP6ASymbol::heightType ( ) const

Returns a TSLDimensionUnits enum indicating the height type.

◆ heightType() [2/2]

void TSLAPP6ASymbol::heightType ( TSLDimensionUnits value )

Use this value to indicate what height type to use when creating entity sets from the symbol. Possible values are pixels, map units or TMCs.

If creating a bitmap, you should set the heightType to pixels and the height to the height of the bitmap.

Parameters

value One of TSLDimensionUnits enum.

◆ higherFormation() [1/2]

const char * TSLAPP6ASymbol::higherFormation ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ higherFormation() [2/2]

void TSLAPP6ASymbol::higherFormation	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ hostileEnemy() [1/2]

const char * TSLAPP6ASymbol::hostileEnemy ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ hostileEnemy() [2/2]

void TSLAPP6ASymbol::hostileEnemy	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ hostility() [1/2]

TSLAPP6ASymbol::HostilityEnum TSLAPP6ASymbol::hostility ( ) const

Queries the hostility value. The hostility is used to determine the type of frame used to build the symbol.

The hostility may be one of TSLAPP6ASymbol::HostilityEnum.

Returns the hostility value.

◆ hostility() [2/2]

void TSLAPP6ASymbol::hostility	(	TSLAPP6ASymbol::HostilityEnum	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_FRAME )

Sets the hostility value. The hostility is used to determine the type of frame used to build the symbol.

The hostility may be one of TSLAPP6ASymbol::HostilityEnum.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ id() [1/2]

const char * TSLAPP6ASymbol::id ( ) const

This method returns the id of the symbol. For example 1.x.1.3.2.

The id is read from the config file when the symbols are loaded.

Returns a pointer to a string containing the id value. This pointer should not be deleted.

◆ id() [2/2]

void TSLAPP6ASymbol::id ( const char * value )

Sets the value of the symbol id. Normally this is loaded from the config file by the helper.

Parameters

value The new id value.

◆ IFFSIFValue() [1/2]

const char * TSLAPP6ASymbol::IFFSIFValue ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ IFFSIFValue() [2/2]

void TSLAPP6ASymbol::IFFSIFValue	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ isFeintDummy() [1/2]

bool TSLAPP6ASymbol::isFeintDummy ( ) const

Returns the Feint Dummy value.

◆ isFeintDummy() [2/2]

void TSLAPP6ASymbol::isFeintDummy	(	bool	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the Feint Dummy value.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ isFramed() [1/2]

bool TSLAPP6ASymbol::isFramed ( ) const

Indicates if the symbol has a frame displayed around it. Note: this only applied to frame optional symbols.

Returns: Returns true if the symbol is framed, false otherwise.

◆ isFramed() [2/2]

void TSLAPP6ASymbol::isFramed ( bool value )

Sets the 'framed' property of this symbol. Note: This only applies to frame optional symbols. Setting this value on symbols that are not framed will have no effect.

Parameters

value The new framed value.

◆ isFrameOptional() [1/2]

bool TSLAPP6ASymbol::isFrameOptional ( ) const

Indicates if this is a frame optional symbol.

Returns: Returns true if the symbol is frame optional, false otherwise.

◆ isFrameOptional() [2/2]

void TSLAPP6ASymbol::isFrameOptional ( bool newValue )

Sets the frame optional status of the symbol. Typically this is set up by the TSLAPP6AHelper and you should not change it.

Parameters

newValue True or false if this is a frame optional symbol.

◆ isHQStaff() [1/2]

bool TSLAPP6ASymbol::isHQStaff ( ) const

Returns the HQ staff value.

◆ isHQStaff() [2/2]

void TSLAPP6ASymbol::isHQStaff	(	bool	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the HQ staff value.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application

◆ isReduced() [1/2]

bool TSLAPP6ASymbol::isReduced ( ) const

Returns The reduced indicator value.

◆ isReduced() [2/2]

void TSLAPP6ASymbol::isReduced	(	bool	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the reduced indicator value.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ isReinforced() [1/2]

bool TSLAPP6ASymbol::isReinforced ( ) const

Returns the reinforced indicator value.

◆ isReinforced() [2/2]

void TSLAPP6ASymbol::isReinforced	(	bool	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the reinforced indicator value.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ isTaskforce() [1/2]

bool TSLAPP6ASymbol::isTaskforce ( ) const

Returns the task force indicator value.

◆ isTaskforce() [2/2]

void TSLAPP6ASymbol::isTaskforce	(	bool	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the task force indicator value.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ key() [1/2]

int TSLAPP6ASymbol::key ( ) const

Returns the integer key value.

◆ key() [2/2]

void TSLAPP6ASymbol::key ( int value )

This is the unique value of this symbol found in the app6aConfig.csv file in the Maplink/Config folder.

This is NOT the same as the value in TSLSymbols.dat. This value can be used to create any of the app6a symbols.

You may however just provide the id of the symbol and the helper will find the proper key for you.

Parameters

value The key value of the symbol to create.

◆ latAndLong() [1/2]

const char * TSLAPP6ASymbol::latAndLong ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ latAndLong() [2/2]

void TSLAPP6ASymbol::latAndLong	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ load()

bool TSLAPP6ASymbol::load ( TSLifstream & stream )

This method gets the next line from the stream and loads its attributes into the class. The line is removed from the stream.

Parameters

stream The file stream to load from.

Returns: true if successful, false otherwise.

◆ mobility() [1/2]

TSLAPP6ASymbol::MobilityEnum TSLAPP6ASymbol::mobility ( ) const

Queries the mobility value. The mobility may be one of TSLAPP6ASymbol::MobilityEnum.

Returns The mobility value.

◆ mobility() [2/2]

void TSLAPP6ASymbol::mobility	(	TSLAPP6ASymbol::MobilityEnum	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the mobility value. The mobility may be one of TSLAPP6ASymbol::MobilityEnum.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ name() [1/2]

const char * TSLAPP6ASymbol::name ( ) const

This method returns the name of the symbol. For example SPACE STATION. This is the name read from the config file when the symbols are loaded.

Returns a pointer to a string containing the name value. This pointer should not be deleted.

◆ name() [2/2]

void TSLAPP6ASymbol::name ( const char * value )

Use this method to set a different name for the symbol.

Parameters

value The new name value.

◆ operator=()

TSLAPP6ASymbol & TSLAPP6ASymbol::operator= ( const TSLAPP6ASymbol & rhs )

Assignment operator.

◆ planned() [1/2]

bool TSLAPP6ASymbol::planned ( ) const

Returns whether this symbol is planned, or present.

◆ planned() [2/2]

void TSLAPP6ASymbol::planned ( bool value )

Sets the planned status value.

The planned status is used to determine whether the frame of the symbol is drawn as a dashed, or solid line.

Note: This only affects the rendering of the symbols frame. The icon of a planned, unframed 2525B symbol will not be drawn with a dashed outline.

Parameters

value The new value.

◆ quantity() [1/2]

const char * TSLAPP6ASymbol::quantity ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ quantity() [2/2]

void TSLAPP6ASymbol::quantity	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ read()

bool TSLAPP6ASymbol::read ( const char * symbol )

This method reads an app6a symbol from a string and populates the class with the attributes found within it.

Parameters

symbol The string to read.

Returns: true if successful, false otherwise. Check the TSLErrorStack for details of the error.

◆ save()

bool TSLAPP6ASymbol::save ( TSLofstream & stream )

This method saves the symbol to the stream and terminates it with a carriage return.

Parameters

stream The file stream to save to.

Returns: true if successful, false otherwise.

◆ signalEquipment() [1/2]

const char * TSLAPP6ASymbol::signalEquipment ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ signalEquipment() [2/2]

void TSLAPP6ASymbol::signalEquipment	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ smallText() [1/2]

bool TSLAPP6ASymbol::smallText ( ) const

Use the smallText option to reduce the size of text modifiers by 1/2. This can be used in conjunction with decluttering to reduce display complexity.

Returns true if the symbol should be created with small text, false otherwise.

◆ smallText() [2/2]

void TSLAPP6ASymbol::smallText ( bool value )

Use the smallText option to reduce the size of text modifiers by 1/2. This can be used in conjunction with decluttering to reduce display complexity.

Parameters

value A boolean value indicating whether small text should be used.

◆ speed() [1/2]

const char * TSLAPP6ASymbol::speed ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ speed() [2/2]

void TSLAPP6ASymbol::speed	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ staffComments() [1/2]

const char * TSLAPP6ASymbol::staffComments ( ) const

Gets the text value.

Returns a pointer to a string containing the text value. This pointer is owned by the TSLAPP6ASymbol object and should not be deleted.

◆ staffComments() [2/2]

void TSLAPP6ASymbol::staffComments	(	const char *	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_TEXT )

Sets the text value.

Parameters

value	The new value.
featureID	A feature id to use when creating this text value. This allows individual items to be decluttered in the client application.

◆ textColour() [1/2]

int TSLAPP6ASymbol::textColour ( ) const

Queries the text colour of the symbol.

Returns the integer text colour as defined in tslcolours.dat.

◆ textColour() [2/2]

void TSLAPP6ASymbol::textColour ( int value )

Use this method to set a different text colour (default black). This is required if the symbol needs to be placed on a black surface.

Parameters

value The index of the colour from tslcolours.dat to use.

◆ type() [1/2]

TSLAPP6ASymbol::TypeEnum TSLAPP6ASymbol::type ( ) const

Queries the symbol type. The type may be one of TSLAPP6ASymbol::TypeEnum.

Returns: the symbol type.

◆ type() [2/2]

void TSLAPP6ASymbol::type ( TSLAPP6ASymbol::TypeEnum value )

Sets the symbol type. The type may be one of TSLAPP6ASymbol::TypeEnum.

Parameters

value The new value.

◆ unitSize() [1/2]

TSLAPP6ASymbol::UnitSizeEnum TSLAPP6ASymbol::unitSize ( ) const

Queries the unit size. The unit size may be one of TSLAPP6ASymbol::UnitSizeEnum.

Returns: The unit size.

◆ unitSize() [2/2]

void TSLAPP6ASymbol::unitSize	(	TSLAPP6ASymbol::UnitSizeEnum	value,
		TSLFeatureID	featureID = TSLAPP6A_DEFAULT_GRAPHIC )

Sets the unit size. The unit size may be one of TSLAPP6ASymbol::UnitSizeEnum.

Parameters

value	The new value.
featureID	A feature id to use when creating this value. This allows individual items to be decluttered in the client application.

◆ write()

bool TSLAPP6ASymbol::write ( TSLSimpleString & data )

This method writes the app6a symbol to the parameter data.

Parameters

data	A string containing the symbol values, or an empty string on error

Returns: true if the symbol values are converted to a string, false if a problem occurs.

◆ x() [1/2]

TSLTMC TSLAPP6ASymbol::x ( ) const

Returns a TSLTMC value indicating the x coordinate.

◆ x() [2/2]

void TSLAPP6ASymbol::x ( TSLTMC value )

Use this method to set the x coordinate of the symbol in TMCs.

Parameters

value The x value.

◆ y() [1/2]

TSLTMC TSLAPP6ASymbol::y ( ) const

Returns a TSLTMC value indicating the y coordinate.

◆ y() [2/2]

void TSLAPP6ASymbol::y ( TSLTMC value )

Use this method to set the y coordinate of the symbol in TMCs.

Parameters

value The y value.

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

◆ HostilityEnum

◆ MobilityEnum

◆ TypeEnum

◆ UnitSizeEnum

Constructor & Destructor Documentation

◆ TSLAPP6ASymbol() [1/2]

◆ TSLAPP6ASymbol() [2/2]

◆ ~TSLAPP6ASymbol()

Member Function Documentation

◆ additionalInformation() [1/2]

◆ additionalInformation() [2/2]

◆ altitudeOrDepth() [1/2]

◆ altitudeOrDepth() [2/2]

◆ C2HQName() [1/2]

◆ C2HQName() [2/2]

◆ combatEffectiveness() [1/2]

◆ combatEffectiveness() [2/2]

◆ dateAndTime() [1/2]

◆ dateAndTime() [2/2]

◆ depth() [1/2]

◆ depth() [2/2]

◆ designation() [1/2]

◆ designation() [2/2]

◆ equipmentType() [1/2]

◆ equipmentType() [2/2]

◆ evaluationRating() [1/2]

◆ evaluationRating() [2/2]

◆ height() [1/2]

◆ height() [2/2]

◆ heightType() [1/2]

◆ heightType() [2/2]

◆ higherFormation() [1/2]

◆ higherFormation() [2/2]

◆ hostileEnemy() [1/2]

◆ hostileEnemy() [2/2]

◆ hostility() [1/2]

◆ hostility() [2/2]

◆ id() [1/2]

◆ id() [2/2]

◆ IFFSIFValue() [1/2]

◆ IFFSIFValue() [2/2]

◆ isFeintDummy() [1/2]

◆ isFeintDummy() [2/2]

◆ isFramed() [1/2]

◆ isFramed() [2/2]

◆ isFrameOptional() [1/2]

◆ isFrameOptional() [2/2]

◆ isHQStaff() [1/2]

◆ isHQStaff() [2/2]

◆ isReduced() [1/2]

◆ isReduced() [2/2]

◆ isReinforced() [1/2]

◆ isReinforced() [2/2]

◆ isTaskforce() [1/2]

◆ isTaskforce() [2/2]

◆ key() [1/2]

◆ key() [2/2]

◆ latAndLong() [1/2]

◆ latAndLong() [2/2]

◆ load()

◆ mobility() [1/2]

◆ mobility() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ operator=()

◆ planned() [1/2]

◆ planned() [2/2]

◆ quantity() [1/2]

◆ quantity() [2/2]

◆ read()

◆ save()

◆ signalEquipment() [1/2]

◆ signalEquipment() [2/2]

◆ smallText() [1/2]

◆ smallText() [2/2]

◆ speed() [1/2]