PointArithmetic Module¶

Module Contents¶

typedef std::map<std::string, PropertyValueT> tracktable::PropertyMap¶

Name -> property map.

We will use this as our container for named properties.

Note: A std::unordered_map (hashtable) would have slightly faster asymptotic performance but we will probably never have enough entries in a single property map for it to even be noticeable, let alone significant.

TRACKTABLE_CORE_EXPORT bool tracktable::has_property(PropertyMap const & properties, string_type const & name)

Check whether a property is present.

Check to see whether a given property is present.

Check the map to see if it contains the given property. This function will not modify the map in any way.

Return

True/false (found or not)

Parameters

[in] properties: Property map to interrogate
[in] name: Name of property to look up

TRACKTABLE_CORE_EXPORT PropertyValueT tracktable::property(PropertyMap const & properties, string_type const & name, bool * is_present)

Retrieve a property regardless of its type.

Retrieve a property from a map whatever its type.

This accessor will let you retrieve the value of a named property regardless of its underlying data type. The catch is that we don’t know whether or not the property is there to begin with. If it isn’t there then we can’t return anything sensible.

We deal with this by letting you pass in an optional pointer to a boolean. We will set its value to true or false depending on whether or not we found the property you wanted. If it is true, the return value is guaranteed to be whatever is in the map. If it is false, the return value will be an empty variant.

This function will give you back the named property as a PropertyValueT (a Boost variant) if it is present in the map. If not, you’ll get back an uninitialized PropertyValueT and the bool pointed at by is_present will be set to ‘false’.

Return

Value of desired property (if present)

Parameters

[in] properties: Property map to interrogate
[in] name: Name of property to find
is_present: Pointer to boolean

On success, returns the requested property and sets *is_present to true. On failure, returns an uninitialized property and sets *is_present to false.

TRACKTABLE_CORE_EXPORT string_type tracktable::string_property(PropertyMap const & properties, string_type const & name, bool * is_present)

Retrieve a string property.

Retrieve a string-valued property from the map.

This accessor will let you retrieve the value of a string property. The catch is that we don’t know whether or not the property is there to begin with. If it isn’t there then we can’t return anything sensible.

We deal with this by letting you pass in an optional pointer to a boolean. We will set its value to true or false depending on whether or not we found the property you wanted. If it is true, the return value is guaranteed to be whatever is in the map. If it is false, the return value will be uninitialized.

This function will give you back the named property as a string_type if it is present and that is its proper type. It will not attempt to cast other types to string_type.

Note

For the purposes of this function, a property that is present but that has the wrong type is the same as a property that is not present in the map.

Return

Value of desired property (if present)

Parameters

[in] properties: Property map to interrogate
[in] name: Name of property to find
is_present: Pointer to boolean

On success, returns the requested property as a string_type and sets *is_present to true. On failure, returns an uninitialized string_type and sets *is_present to false.

TRACKTABLE_CORE_EXPORT double tracktable::real_property(PropertyMap const & properties, string_type const & name, bool * is_present)

Retrieve a numeric property.

Retrieve a real-valued property from the map.

This accessor will let you retrieve the value of a numeric property. The catch is that we don’t know whether or not the property is there to begin with. If it isn’t there then we can’t return anything sensible.

We deal with this by letting you pass in an optional pointer to a boolean. We will set its value to true or false depending on whether or not we found the property you wanted. If it is true, the return value is guaranteed to be whatever is in the map. If it is false, the return value will be uninitialized.

This function will give you back the named property as a double-precision floating point number if it is present and that is its proper type. It will not attempt to cast other types to double.

Note

For the purposes of this function, a property that is present but that has the wrong type is the same as a property that is not present in the map.

Return

Value of desired property (if present)

Parameters

[in] properties: Property map to interrogate
[in] name: Name of property to find
is_present: Pointer to boolean

On success, returns the requested property as a double and sets *is_present to true. On failure, returns 0 and sets *is_present to false.

TRACKTABLE_CORE_EXPORT Timestamp tracktable::timestamp_property(PropertyMap const & properties, string_type const & name, bool * is_present)

Retrieve a timestamp property.

Retrieve a timestamp-valued property from the map.

This accessor will let you retrieve the value of a timestamp property. The catch is that we don’t know whether or not the property is there to begin with. If it isn’t there then we can’t return anything sensible.

We deal with this by letting you pass in an optional pointer to a boolean. We will set its value to true or false depending on whether or not we found the property you wanted. If it is true, the return value is guaranteed to be whatever is in the map. If it is false, the return value will be uninitialized.

This function will give you back the named property as a Timestamp if it is present and that is its proper type. It will not attempt to cast other types to Timestamp.

Note

For the purposes of this function, a property that is present but that has the wrong type is the same as a property that is not present in the map.

Return

Value of desired property (if present)

Parameters

[in] properties: Property map to interrogate
[in] name: Name of property to find
is_present: Pointer to boolean

On success, returns the requested property as a Timestamp and sets *is_present to true. On failure, returns an uninitialized timestamp and sets *is_present to false.

Warning