|
static boost::optional< OF_SHARED_PTR< modelgbp::epdr::L2Discovered > > | resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri) |
| Retrieve an instance of L2Discovered from the managed object store. More...
|
|
static boost::optional< OF_SHARED_PTR< modelgbp::epdr::L2Discovered > > | resolve (const opflex::modb::URI &uri) |
| Retrieve an instance of L2Discovered from the managed object store using the default framework instance. More...
|
|
static boost::optional< OF_SHARED_PTR< modelgbp::epdr::L2Discovered > > | resolve (opflex::ofcore::OFFramework &framework) |
| Retrieve an instance of L2Discovered from the managed object store by constructing its URI from the path elements that lead to it. More...
|
|
static boost::optional< OF_SHARED_PTR< modelgbp::epdr::L2Discovered > > | resolve () |
| Retrieve an instance of L2Discovered from the default managed object store by constructing its URI from the path elements that lead to it. More...
|
|
static void | remove (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri) |
| Remove the L2Discovered object with the specified URI using the currently-active mutator. More...
|
|
static void | remove (const opflex::modb::URI &uri) |
| Remove the L2Discovered object with the specified URI using the currently-active mutator and the default framework instance. More...
|
|
static void | registerListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener) |
| Register a listener that will get called for changes related to this class. More...
|
|
static void | registerListener (opflex::modb::ObjectListener *listener) |
| Register a listener that will get called for changes related to this class with the default framework instance. More...
|
|
static void | unregisterListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener) |
| Unregister a listener from updates to this class. More...
|
|
static void | unregisterListener (opflex::modb::ObjectListener *listener) |
| Unregister a listener from updates to this class from the default framework instance. More...
|
|
◆ L2Discovered()
modelgbp::epdr::L2Discovered::L2Discovered |
( |
opflex::ofcore::OFFramework & |
framework, |
|
|
const opflex::modb::URI & |
uri, |
|
|
const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > & |
oi |
|
) |
| |
|
inline |
Construct an instance of L2Discovered.
This should not typically be called from user code.
◆ addEpdrLocalL2Ep()
OF_SHARED_PTR<modelgbp::epdr::LocalL2Ep> modelgbp::epdr::L2Discovered::addEpdrLocalL2Ep |
( |
const std::string & |
epdrLocalL2EpUuid | ) |
|
|
inline |
Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.
If the object already exists in the store, get a mutable copy of that object. If the object already exists in the mutator, get a reference to the object.
- Parameters
-
epdrLocalL2EpUuid | the value of epdrLocalL2EpUuid, a naming property for LocalL2Ep |
- Exceptions
-
std::logic_error | if no mutator is active |
- Returns
- a shared pointer to the (possibly new) object
References CLASS_ID.
◆ registerListener() [1/2]
static void modelgbp::epdr::L2Discovered::registerListener |
( |
opflex::ofcore::OFFramework & |
framework, |
|
|
opflex::modb::ObjectListener * |
listener |
|
) |
| |
|
inlinestatic |
Register a listener that will get called for changes related to this class.
This listener will be called for any modifications of this class or any transitive children of this class.
- Parameters
-
framework | the framework instance |
listener | the listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered. |
References CLASS_ID.
Referenced by registerListener().
◆ registerListener() [2/2]
static void modelgbp::epdr::L2Discovered::registerListener |
( |
opflex::modb::ObjectListener * |
listener | ) |
|
|
inlinestatic |
Register a listener that will get called for changes related to this class with the default framework instance.
This listener will be called for any modifications of this class or any transitive children of this class.
- Parameters
-
listener | the listener functional object that should be called when changes occur related to the class. This memory is owned by the caller and should be freed only after it has been unregistered. |
References registerListener().
◆ remove() [1/3]
void modelgbp::epdr::L2Discovered::remove |
( |
| ) |
|
|
inline |
Remove this instance using the currently-active mutator.
If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.
- Exceptions
-
std::logic_error | if no mutator is active |
References CLASS_ID.
◆ remove() [2/3]
static void modelgbp::epdr::L2Discovered::remove |
( |
opflex::ofcore::OFFramework & |
framework, |
|
|
const opflex::modb::URI & |
uri |
|
) |
| |
|
inlinestatic |
Remove the L2Discovered object with the specified URI using the currently-active mutator.
If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.
- Parameters
-
framework | the framework instance to use |
uri | the URI of the object to remove |
- Exceptions
-
std::logic_error | if no mutator is active |
References CLASS_ID.
◆ remove() [3/3]
static void modelgbp::epdr::L2Discovered::remove |
( |
const opflex::modb::URI & |
uri | ) |
|
|
inlinestatic |
Remove the L2Discovered object with the specified URI using the currently-active mutator and the default framework instance.
If the object does not exist, then this will be a no-op. If this object has any children, they will be garbage-collected at some future time.
- Parameters
-
uri | the URI of the object to remove |
- Exceptions
-
std::logic_error | if no mutator is active |
◆ resolve() [1/4]
static boost::optional<OF_SHARED_PTR<modelgbp::epdr::L2Discovered> > modelgbp::epdr::L2Discovered::resolve |
( |
opflex::ofcore::OFFramework & |
framework, |
|
|
const opflex::modb::URI & |
uri |
|
) |
| |
|
inlinestatic |
Retrieve an instance of L2Discovered from the managed object store.
If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.
- Parameters
-
framework | the framework instance to use |
uri | the URI of the object to retrieve |
- Returns
- a shared pointer to the object or boost::none if it does not exist.
References CLASS_ID.
◆ resolve() [2/4]
Retrieve an instance of L2Discovered from the managed object store using the default framework instance.
If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.
- Parameters
-
uri | the URI of the object to retrieve |
- Returns
- a shared pointer to the object or boost::none if it does not exist.
References CLASS_ID.
◆ resolve() [3/4]
static boost::optional<OF_SHARED_PTR<modelgbp::epdr::L2Discovered> > modelgbp::epdr::L2Discovered::resolve |
( |
opflex::ofcore::OFFramework & |
framework | ) |
|
|
inlinestatic |
Retrieve an instance of L2Discovered from the managed object store by constructing its URI from the path elements that lead to it.
If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.
The object URI generated by this function will take the form: /EpdrL2Discovered
- Parameters
-
framework | the framework instance to use |
- Returns
- a shared pointer to the object or boost::none if it does not exist.
References resolve().
◆ resolve() [4/4]
Retrieve an instance of L2Discovered from the default managed object store by constructing its URI from the path elements that lead to it.
If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.
The object URI generated by this function will take the form: /EpdrL2Discovered
- Returns
- a shared pointer to the object or boost::none if it does not exist.
Referenced by resolve(), and modelgbp::dmtree::Root::resolveEpdrL2Discovered().
◆ resolveEpdrLocalL2Ep() [1/2]
boost::optional<OF_SHARED_PTR<modelgbp::epdr::LocalL2Ep> > modelgbp::epdr::L2Discovered::resolveEpdrLocalL2Ep |
( |
const std::string & |
epdrLocalL2EpUuid | ) |
|
|
inline |
Retrieve the child object with the specified naming properties.
If the object does not exist in the local store, returns boost::none. Note that even though it may not exist locally, it may still exist remotely.
- Parameters
-
epdrLocalL2EpUuid | the value of epdrLocalL2EpUuid, a naming property for LocalL2Ep |
- Returns
- a shared pointer to the object or boost::none if it does not exist.
References modelgbp::epdr::LocalL2Ep::resolve().
◆ resolveEpdrLocalL2Ep() [2/2]
Resolve and retrieve all of the immediate children of type modelgbp::epdr::LocalL2Ep.
Note that this retrieves only those children that exist in the local store. It is possible that there are other children that exist remotely.
The resulting managed objects will be added to the result vector provided.
- Parameters
-
out | a reference to a vector that will receive the child objects. |
References CLASS_ID.
◆ unregisterListener() [1/2]
static void modelgbp::epdr::L2Discovered::unregisterListener |
( |
opflex::ofcore::OFFramework & |
framework, |
|
|
opflex::modb::ObjectListener * |
listener |
|
) |
| |
|
inlinestatic |
Unregister a listener from updates to this class.
- Parameters
-
framework | the framework instance |
listener | The listener to unregister. |
References CLASS_ID.
Referenced by unregisterListener().
◆ unregisterListener() [2/2]
static void modelgbp::epdr::L2Discovered::unregisterListener |
( |
opflex::modb::ObjectListener * |
listener | ) |
|
|
inlinestatic |
Unregister a listener from updates to this class from the default framework instance.
- Parameters
-
listener | The listener to unregister. |
References unregisterListener().
The documentation for this class was generated from the following file: