SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Types | Public Member Functions | List of all members
smtk::resource::detail::ResourceProperties Class Reference

This specialization of smtk::resource::Properties completes aforementioned class's implementation by holding a customization of smtk::common::Properties as described in the above detail namespace. More...

#include <Properties.h>

Inheritance diagram for smtk::resource::detail::ResourceProperties:
[legend]
Collaboration diagram for smtk::resource::detail::ResourceProperties:
[legend]

Public Types

typedef std::tuple< Indexed< bool >, Indexed< int >, Indexed< long >, Indexed< double >, Indexed< std::string >, Indexed< smtk::string::Token >, Indexed< std::set< smtk::string::Token > >, Indexed< std::set< int > >, Indexed< std::vector< bool > >, Indexed< std::vector< int > >, Indexed< std::vector< long > >, Indexed< std::vector< double > >, Indexed< std::vector< std::string > >, Indexed< smtk::resource::properties::CoordinateFrame >, Indexed< std::map< std::string, smtk::resource::properties::CoordinateFrame > > > PropertyTypes
 The default value types for all resources and components are. More...
 
- Public Types inherited from smtk::resource::Properties
template<typename Type >
using Indexed = std::unordered_map< smtk::common::UUID, Type >
 

Public Member Functions

ResourcePropertiesDatadata ()
 
const ResourcePropertiesDatadata () const
 
template<typename Type >
void insertPropertyType ()
 
std::size_t clear () override
 Remove all properties this object manages.
 
- Public Member Functions inherited from smtk::resource::Properties
template<typename Type >
bool contains (const std::string &key) const
 Check whether a property associated with key is present.
 
template<typename Type >
bool insert (const std::string &key, const Type &value)
 Insert (key, value ) into the container.
 
template<typename Type >
bool emplace (const std::string &key, Type &&value)
 Emplace (key, value ) into the container.
 
template<typename Type >
void erase (const std::string &key)
 Erase property indexed by key from the container.
 
template<typename Type >
Type & at (const std::string &key)
 Access property indexed by key.
 
template<typename Type >
const Type & at (const std::string &key) const
 Access property indexed by key.
 
template<typename Type >
PropertiesOfType< Type > get ()
 Access properties of type Type.
 
template<typename Type >
const ConstPropertiesOfType< Type > get () const
 Access properties of type Type.
 

Additional Inherited Members

- Protected Member Functions inherited from smtk::resource::Properties
template<typename PropertyTypeTuple >
std::size_t clearInternal (const smtk::common::UUID &uid)
 This is a method subclasses may call from their implementation of clear() in order to iterate over all acceptable property types and remove a UUID from the map.
 

Detailed Description

This specialization of smtk::resource::Properties completes aforementioned class's implementation by holding a customization of smtk::common::Properties as described in the above detail namespace.

Member Typedef Documentation

◆ PropertyTypes

typedef std::tuple< Indexed<bool>, Indexed<int>, Indexed<long>, Indexed<double>, Indexed<std::string>, Indexed<smtk::string::Token>, Indexed<std::set<smtk::string::Token> >, Indexed<std::set<int> >, Indexed<std::vector<bool> >, Indexed<std::vector<int> >, Indexed<std::vector<long> >, Indexed<std::vector<double> >, Indexed<std::vector<std::string> >, Indexed<smtk::resource::properties::CoordinateFrame>, Indexed<std::map<std::string, smtk::resource::properties::CoordinateFrame> > > smtk::resource::detail::ResourceProperties::PropertyTypes

The default value types for all resources and components are.

  • int, double, string, and vectors of these types;
  • string tokens (integer hashes into a map producing strings) and sets of string tokens;
  • CoordinateFrame values plus maps from strings to CoordinateFrames.

The documentation for this class was generated from the following files: