cesium-native 0.62.0
Loading...
Searching...
No Matches
Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue Struct Referencefinal

ExtensionSchemaMaxarContentGeoJson Properties Value. More...

#include <Cesium3DTiles/ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h>

Inheritance diagram for Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue:
CesiumUtility::ExtensibleObject

Classes

struct  Type
 Known values for Expected datatype of the property value in the GeoJSON Feature's 'properties' object. More...
 

Public Member Functions

int64_t getSizeBytes () const
 Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.
 
- Public Member Functions inherited from CesiumUtility::ExtensibleObject
template<typename T>
bool hasExtension () const noexcept
 Checks if an extension exists given its static type.
 
template<typename T>
const T * getExtension () const noexcept
 Gets an extension given its static type.
 
template<typename T>
T * getExtension () noexcept
 Gets an extension given its static type.
 
const JsonValuegetGenericExtension (const std::string &extensionName) const noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue.
 
JsonValuegetGenericExtension (const std::string &extensionName) noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue.
 
template<typename T, typename... ConstructorArgumentTypes>
T & addExtension (ConstructorArgumentTypes &&... constructorArguments)
 Adds a statically-typed extension to this object.
 
template<typename T>
void removeExtension ()
 Removes a statically-typed extension from this object.
 
int64_t getSizeBytes () const
 Calculates the size in bytes of this ExtensibleObject, including all of its extras but NOT including its extensions. Calling this method may be slow as it requires traversing the entire object.
 

Public Attributes

std::string id
 Unique property identifier that corresponds to a property name in the GeoJSON Feature's 'properties' object.
 
std::string type = Type::Integer
 Expected datatype of the property value in the GeoJSON Feature's 'properties' object.
 
std::optional< std::string > description
 Human readable description of the property.
 
std::optional< std::string > unit
 Unit of the specified property.
 
std::optional< double > max
 Maximum allowed value for the property. Only applicable to integer and float types. When both min and max are specified, max must be greater than or equal to min.
 
std::optional< double > min
 Minimum allowed value for the property. Only applicable to integer and float types. When both min and max are specified, min must be less than or equal to max.
 
std::optional< bool > required = std::optional<bool>()
 If true, this property must be present in the 'properties' object of every GeoJSON Feature in the associated tile content.
 
std::optional< CesiumUtility::JsonValuedefaultProperty
 A default value to use when this property is missing from a GeoJSON Feature's 'properties' object. Shall not be defined if required is true.
 
std::optional< std::string > semantic
 An identifier that describes how this property should be interpreted. The semantic cannot be used by other properties in the properties schema.
 
- Public Attributes inherited from CesiumUtility::ExtensibleObject
std::unordered_map< std::string, std::any > extensions
 The extensions attached to this object.
 
JsonValue::Object extras
 Application-specific data.
 
JsonValue::Object unknownProperties
 Unknown properties that exist on this object but do not have any representation in the statically-typed classes.
 

Static Public Attributes

static constexpr const char * TypeName
 The original name of this type.
 

Detailed Description

Member Function Documentation

◆ getSizeBytes()

int64_t Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::getSizeBytes ( ) const
inline

Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.

Definition at line 109 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

Member Data Documentation

◆ defaultProperty

std::optional<CesiumUtility::JsonValue> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::defaultProperty

A default value to use when this property is missing from a GeoJSON Feature's 'properties' object. Shall not be defined if required is true.

Definition at line 94 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ description

std::optional<std::string> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::description

Human readable description of the property.

Definition at line 63 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ id

std::string Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::id

Unique property identifier that corresponds to a property name in the GeoJSON Feature's 'properties' object.

Definition at line 49 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ max

std::optional<double> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::max

Maximum allowed value for the property. Only applicable to integer and float types. When both min and max are specified, max must be greater than or equal to min.

Definition at line 75 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ min

std::optional<double> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::min

Minimum allowed value for the property. Only applicable to integer and float types. When both min and max are specified, min must be less than or equal to max.

Definition at line 82 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ required

std::optional<bool> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::required = std::optional<bool>()

If true, this property must be present in the 'properties' object of every GeoJSON Feature in the associated tile content.

Definition at line 88 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ semantic

std::optional<std::string> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::semantic

An identifier that describes how this property should be interpreted. The semantic cannot be used by other properties in the properties schema.

Definition at line 101 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ type

std::string Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::type = Type::Integer

Expected datatype of the property value in the GeoJSON Feature's 'properties' object.

Known values are defined in Type.

Definition at line 58 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ TypeName

const char* Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::TypeName
staticconstexpr
Initial value:
=
"ExtensionSchemaMaxarContentGeoJsonPropertiesValue"

The original name of this type.

Definition at line 21 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.

◆ unit

std::optional<std::string> Cesium3DTiles::ExtensionSchemaMaxarContentGeoJsonPropertiesValue::unit

Unit of the specified property.

Definition at line 68 of file ExtensionSchemaMaxarContentGeoJsonPropertiesValue.h.


The documentation for this struct was generated from the following file: