Detailed Description
Shared classes.
This includes base classes and interfaces which are extended or implemented by inheriting classes.
Data Structures | |
| class | Collection |
| A group of items accessible by index or key. More... | |
| class | CollectionConfig |
| C++ class wrapper for the fiftyoneDegreesCollectionConfig structure. More... | |
| class | ComponentMetaData |
| EntityMetaData relating to a component populated by an engine implementation. More... | |
| class | ConfigBase |
| C++ class wrapper for the fiftyoneDegreesConfigBase configuration structure. More... | |
| class | Date |
| The Date class wraps the C fiftyoneDegreesDate structure and is used to represent dates in engines. More... | |
| class | EngineBase |
| Encapsulates the engine class to be extended by engine implementations. More... | |
| class | EntityMetaData |
| Base class for any entity meta data. More... | |
| class | EntityMetaDataBuilder |
| Meta data builder class contains static helper methods used when building meta data instances. More... | |
| class | EvidenceBase |
| Base evidence class containing evidence to be processed by an engine. More... | |
| class | EvidenceException |
| Exception thrown when there is a problem with the evidence provided. More... | |
| class | FatalException |
| Fatal exception meaning the process should be halted. More... | |
| class | InvalidPropertyException |
| Exception thrown when a property does not exist in the data set. More... | |
| class | MetaData |
| Contains meta data for the properties, values, profiles and components that exist within the engine instance. More... | |
| class | NotImplementedException |
| Exception indicating that the method has not been implemented by the class. More... | |
| class | NoValuesAvailableException |
| Exception indicating that there were no values in the results for the requested property. More... | |
| class | ProfileMetaData |
| Meta data relating to a profile populated by an engine implementation. More... | |
| class | PropertyMetaData |
| Meta data relating to a property populated by an engine implementation. More... | |
| class | RequiredPropertiesConfig |
| C++ class wrapper for the fiftyoneDegreesPropertiesRequired structure. More... | |
| class | ResultsBase |
| Encapsulates the results of an engine's processing. More... | |
| class | StatusCodeException |
| Exception containing the status code which caused the exception. More... | |
| class | TooManyValuesException |
| Exception indicating that an attempt was made to return a single value type (e.g. More... | |
| class | Value |
| Encapsulates a value returned an instance of ResultsBase for a specified property. More... | |
| class | ValueMetaData |
| Meta data relating to a value populated by an engine implementation. More... | |
| class | ValueMetaDataKey |
| Key used to store ValueMetaData in a Collection. More... | |
Functions | |
| FIFTYONE_DEGREES_COMMON_CXX_BEGIN void | writeStoredBinaryValueToStringStream (const fiftyoneDegreesStoredBinaryValue *binaryValue, fiftyoneDegreesPropertyValueType valueType, std::stringstream &stream, uint8_t decimalPlaces, fiftyoneDegreesException *exception) |
| Converts stored binary value to text and pushes into a string stream. | |
| FIFTYONE_DEGREES_COMMON_CXX_BEGIN fiftyoneDegreesWkbtotResult | writeWkbStringToStringStream (const fiftyoneDegreesVarLengthByteArray *wkbString, fiftyoneDegreesWkbtotReductionMode reductionMode, std::stringstream &stream, uint8_t decimalPlaces, fiftyoneDegreesException *exception) |
| Converts WKB "string" to WKT string and pushes into a string stream. | |
Function Documentation
◆ writeStoredBinaryValueToStringStream()
| FIFTYONE_DEGREES_COMMON_CXX_BEGIN void FiftyoneDegrees::Common::writeStoredBinaryValueToStringStream | ( | const fiftyoneDegreesStoredBinaryValue * | binaryValue, |
| fiftyoneDegreesPropertyValueType | valueType, | ||
| std::stringstream & | stream, | ||
| uint8_t | decimalPlaces, | ||
| fiftyoneDegreesException * | exception ) |
Converts stored binary value to text and pushes into a string stream.
- Parameters
-
binaryValue stored binary value from data file stream string stream to push WKT into. decimalPlaces precision for numbers (places after the decimal dot). exception pointer to the exception struct.
◆ writeWkbStringToStringStream()
| FIFTYONE_DEGREES_COMMON_CXX_BEGIN fiftyoneDegreesWkbtotResult FiftyoneDegrees::Common::writeWkbStringToStringStream | ( | const fiftyoneDegreesVarLengthByteArray * | wkbString, |
| fiftyoneDegreesWkbtotReductionMode | reductionMode, | ||
| std::stringstream & | stream, | ||
| uint8_t | decimalPlaces, | ||
| fiftyoneDegreesException * | exception ) |
Converts WKB "string" to WKT string and pushes into a string stream.
- Parameters
-
wkbString "string" containing WKB geometry. reductionMode type/value reduction applied to decrease WKB size. stream string stream to push WKT into. decimalPlaces precision for numbers (places after the decimal dot). exception pointer to the exception struct.
- Returns
- How many bytes were written to the buffer and if it was too small.