ECEnabler for standalone ECInstances (IECInstances not tied to a specific persistent store) More...
#include <StandaloneECInstance.h>
Inheritance diagram for StandaloneECEnabler:
Public Member Functions | |
| StandaloneECInstancePtr | CreateInstance (uint32_t minimumInitialSize=0) |
| Creates a StandaloneECInstance. More... | |
| ClassLayoutCR | GetClassLayout () const |
| Gets the ClassLayout associated with this enabler. More... | |
| ClassLayoutR | GetClassLayout () |
| Gets the ClassLayout associated with this enabler. More... | |
 Public Member Functions inherited from ECEnabler | |
| WCharCP | GetName () const |
| Primarily for debugging/logging purposes. More... | |
| ECClassCR | GetClass () const |
| Get the ECClass that this enabler 'enables'. More... | |
| ECObjectsStatus | GetPropertyIndex (uint32_t &propertyIndex, WCharCP propertyAccessString) const |
| Obtain a propertyIndex given an access string. More... | |
| ECObjectsStatus | GetAccessString (WCharCP &propertyAccessString, uint32_t propertyIndex) const |
| Given a propertyIndex, find the corresponding property access string. More... | |
| uint32_t | GetFirstPropertyIndex (uint32_t parentIndex) const |
| Obtain the property index of the first property of this enabler's ECClass (if parentIndex == 0), or the first child property of the struct property indicated by parentIndex. More... | |
| uint32_t | GetNextPropertyIndex (uint32_t parentIndex, uint32_t inputIndex) const |
| Get the next (after inputIndex) propertyIndex (used in conjunction with GetFirstPropertyIndex for efficiently looping over property values.) More... | |
| bool | HasChildProperties (uint32_t parentIndex) const |
| Return true if the property associated with parentIndex has child properties. More... | |
| uint32_t | GetParentPropertyIndex (uint32_t childIndex) const |
| If childIndex refers to a member of a struct, returns the index of the struct property which contains it. More... | |
| ECObjectsStatus | GetPropertyIndices (bvector< uint32_t > &indices, uint32_t parentIndex) const |
| Get vector of all property indices for property defined by parent index. More... | |
| IStandaloneEnablerLocaterR | GetStandaloneEnablerLocater () |
| Get the IStandaloneEnablerLocater for this enabler. More... | |
| StandaloneECEnablerPtr | GetEnablerForStructArrayMember (SchemaKeyCR schemaKey, WCharCP className) |
| Returns an enabler for the given class from the given schema. More... | |
| Public Member Functions inherited from RefCounted< IRefCounted > | |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
| UInt32 | AddRef () const |
| UInt32 | Release () const |
| RefCounted () | |
| RefCounted (RefCounted const &rhs) | |
| RefCounted & | operator= (RefCounted const &rhs) |
| UInt32 | GetRefCount () const |
Static Public Member Functions | |
| static StandaloneECEnablerPtr | CreateEnabler (ECClassCR ecClass, ClassLayoutR classLayout, IStandaloneEnablerLocaterP structStandaloneEnablerLocater) |
| if structStandaloneEnablerLocater is NULL, we'll use GetDefaultStandaloneEnabler for embedded structs Creates a StandaloneECEnabler for the specified ECClass More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from RefCounted< IRefCounted > | |
| virtual | ~RefCounted () |
| Protected Member Functions inherited from IRefCounted | |
| virtual | ~IRefCounted () |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
Detailed Description
ECEnabler for standalone ECInstances (IECInstances not tied to a specific persistent store)
- See also
- StandaloneECInstance
Member Function Documentation
|
static |
if structStandaloneEnablerLocater is NULL, we'll use GetDefaultStandaloneEnabler for embedded structs Creates a StandaloneECEnabler for the specified ECClass
- Parameters
-
[in] ecClass The ECClass for which to create the enabler [in] classLayout The ClassLayout associated with the specified ECClass [in] structStandaloneEnablerLocater An object capable of locating StandaloneECEnablers for struct properties. If NULL, ECClass::GetDefaultStandaloneEnabler() will be used.
- Returns
- A StandaloneECEnabler, or nullptr if the enabler could not be created
| StandaloneECInstancePtr CreateInstance | ( | uint32_t | minimumInitialSize = 0 | ) |
Creates a StandaloneECInstance.
- Parameters
-
[in] minimumInitialSize The number of bytes to allocate in the buffer. Typically useful only when preparing to copy values from another StandaloneECInstance with a known allocation.
- Returns
- A StandaloneECInstance of the ECClass associated with this ECEnabler.
| ClassLayoutCR GetClassLayout | ( | ) | const |
Gets the ClassLayout associated with this enabler.
- Returns
- the ClassLayout associated with this enabler
| ClassLayoutR GetClassLayout | ( | ) |
Gets the ClassLayout associated with this enabler.
- Returns
- the ClassLayout associated with this enabler
The documentation for this struct was generated from the following file: