Murl::PropertyInfo Class Reference

A container for storing property information about a class. More...

#include "murl_property_info.h"

Classes

struct  Item
 A single property information item. More...
 

Public Member Functions

 PropertyInfo (const Item **items, UInt32 numberOfItems)
 The constructor. More...
 
UInt32 GetNumberOfItems () const
 Get the number of items. More...
 
const ItemGetItemByIndex (UInt32 index) const
 Get a single item by its index. More...
 
const ItemGetItemById (UInt32 id) const
 Get a single item by its ID. More...
 
const ItemGetItemByName (const String &name) const
 Get a single item by its name. More...
 
UInt32 GetIdByNameAndHash (const String &name, UInt32 hash) const
 Get the ID of an item by its name. More...
 

Detailed Description

A container for storing property information about a class.

This class holds an array of individual items each describing a single object property, which is essentially a single class member encapsulating one or more variable elements, which in turn can consist of one or more individual components. For example, a Graph::VectorFieldProperty stores a fixed-size array of NUM_ELEMENTS individual Graph::Vector instances, each of which has 4 components. See also Murl::IFactoryObject and Murl::AttributeInfo.

Constructor & Destructor Documentation

◆ PropertyInfo()

Murl::PropertyInfo::PropertyInfo ( const Item **  items,
UInt32  numberOfItems 
)
inline

The constructor.

Parameters
itemsAn array of pointers to individual property info items.
numberOfItemsThe number of items in the array.

Member Function Documentation

◆ GetNumberOfItems()

UInt32 Murl::PropertyInfo::GetNumberOfItems ( ) const
inline

Get the number of items.

Returns
The number of items.

◆ GetItemByIndex()

const Item* Murl::PropertyInfo::GetItemByIndex ( UInt32  index) const
inline

Get a single item by its index.

Parameters
indexThe item index, from 0 to GetNumberOfItems()-1.
Returns
The item, or null if index is out of range.

◆ GetItemById()

const Item* Murl::PropertyInfo::GetItemById ( UInt32  id) const
inline

Get a single item by its ID.

Parameters
idThe ID to search for.
Returns
The item, or null if the given ID was not found.

◆ GetItemByName()

const Item* Murl::PropertyInfo::GetItemByName ( const String name) const
inline

Get a single item by its name.

Parameters
nameThe name to search for.
Returns
The item, or null if the given name was not found.

◆ GetIdByNameAndHash()

UInt32 Murl::PropertyInfo::GetIdByNameAndHash ( const String name,
UInt32  hash 
) const
inline

Get the ID of an item by its name.

Parameters
nameThe name to search for.
hashThe name string's hash value.
Returns
The ID, 0xffffffff if the name was not found.

The documentation for this class was generated from the following file:
  • murl_property_info.h


Copyright © 2011-2018 Spraylight GmbH.