OpFlex Framework
1.3.0
|
Class info provides metadata about managed object classes and properties. More...
#include <opflex/modb/ClassInfo.h>
Public Types | |
enum | class_type_t { POLICY, REMOTE_ENDPOINT, LOCAL_ENDPOINT, OBSERVABLE, LOCAL_ONLY, RESOLVER, RELATIONSHIP, REVERSE_RELATIONSHIP } |
The type of an MO in the Opflex protocol. More... | |
typedef boost::unordered_map < prop_id_t, PropertyInfo > | property_map_t |
A map from a prop_id_t to a PropertyInfo object. | |
Public Member Functions | |
ClassInfo () | |
Default constructor. | |
ClassInfo (class_id_t class_id, class_type_t class_type, const std::string &class_name, const std::string &owner, const std::vector< PropertyInfo > &properties, const std::vector< prop_id_t > &naming_props) | |
Construct a class info object for the given class ID. | |
~ClassInfo () | |
Destroy the class index. | |
const std::string & | getName () const |
Get the name for this class. More... | |
const std::string & | getOwner () const |
Get the owner for this class. More... | |
class_id_t | getId () const |
Get the unique class ID for this class. More... | |
class_type_t | getType () const |
Get the type of this class. More... | |
const property_map_t & | getProperties () const |
Get the properties that exist for this class. More... | |
const std::vector< prop_id_t > & | getNamingProps () const |
Get the vector of naming properties (in order) that make up the key or naming properties for this class. More... | |
const PropertyInfo & | getProperty (const std::string &name) const |
Get the PropertyInfo for the given named property. More... | |
const PropertyInfo & | getProperty (prop_id_t &prop_id) const |
Get the PropertyInfo for the given property ID. More... | |
Class info provides metadata about managed object classes and properties.
This metadata is generated by the code generation framework and is required when the framework is initialized.
The type of an MO in the Opflex protocol.
Updates to these MOs will trigger different operations depending on their types.
|
inline |
Get the unique class ID for this class.
|
inline |
Get the name for this class.
|
inline |
Get the vector of naming properties (in order) that make up the key or naming properties for this class.
|
inline |
Get the owner for this class.
|
inline |
Get the properties that exist for this class.
|
inline |
Get the PropertyInfo for the given named property.
name | the name of the property |
std::out_of_range | if there is no property with that name |
|
inline |
Get the PropertyInfo for the given property ID.
prop_id | the ID of the property |
std::out_of_range | if there is no property with that ID |
|
inline |