Back to Aurora Vision Library Lite website
You are here: Start » Basic » Format » FormatLocationToString
FormatLocationToString
Header: | AVL.h |
---|---|
Namespace: | avl |
Converts a location to a string of format "(X, Y)".
Syntax
void avl::FormatLocationToString ( const avl::Location& inLocation, const int inDigitCount, const atl::String& inTrailingCharacter, const bool inForceSignPrinting, const atl::String& inSuffix, const int inSystemBase, const bool inPrintBrackets, atl::String& outString )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inLocation | const Location& | ||||
inDigitCount | const int | 0 - | How many characters the output coordinate should have at least | ||
inTrailingCharacter | const String& | \"0\" | Defines the trailing character | ||
inForceSignPrinting | const bool | False | Forces printing the signs of the coordinates even if the number is positive | ||
inSuffix | const String& | \"\" | Defines a suffix. Generally it is an unit of value (e.g. mm) | ||
inSystemBase | const int | 2 - 16 | 10 | The base of the numeral system | |
inPrintBrackets | const bool | True | Determines whether the brackets should be printed or not | ||
outString | String& |