modelgbp Generated OpFlex Model
1.7.0
|
Public Member Functions | |
bool | isMulticastGroupIPSet () |
Check whether multicastGroupIP has been set. More... | |
boost::optional< const std::string & > | getMulticastGroupIP () |
Get the value of multicastGroupIP if it has been set. More... | |
const std::string & | getMulticastGroupIP (const std::string &defaultValue) |
Get the value of multicastGroupIP if set, otherwise the value of default passed in. More... | |
modelgbp::gbpe::FloodContext & | setMulticastGroupIP (const std::string &newValue) |
Set multicastGroupIP to the specified value in the currently-active mutator. More... | |
modelgbp::gbpe::FloodContext & | unsetMulticastGroupIP () |
Unset multicastGroupIP in the currently-active mutator. More... | |
void | remove () |
Remove this instance using the currently-active mutator. More... | |
FloodContext (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi) | |
Construct an instance of FloodContext. More... | |
Static Public Member Functions | |
static boost::optional < OF_SHARED_PTR < modelgbp::gbpe::FloodContext > > | resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri) |
Retrieve an instance of FloodContext from the managed object store. More... | |
static boost::optional < OF_SHARED_PTR < modelgbp::gbpe::FloodContext > > | resolve (const opflex::modb::URI &uri) |
Retrieve an instance of FloodContext from the managed object store using the default framework instance. More... | |
static boost::optional < OF_SHARED_PTR < modelgbp::gbpe::FloodContext > > | resolve (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpFloodDomainName) |
Retrieve an instance of FloodContext 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::gbpe::FloodContext > > | resolve (const std::string &policySpaceName, const std::string &gbpFloodDomainName) |
Retrieve an instance of FloodContext 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 FloodContext object with the specified URI using the currently-active mutator. More... | |
static void | remove (const opflex::modb::URI &uri) |
Remove the FloodContext object with the specified URI using the currently-active mutator and the default framework instance. More... | |
static void | remove (opflex::ofcore::OFFramework &framework, const std::string &policySpaceName, const std::string &gbpFloodDomainName) |
Remove the FloodContext object with the specified path elements from the managed object store. More... | |
static void | remove (const std::string &policySpaceName, const std::string &gbpFloodDomainName) |
Remove the FloodContext object with the specified path elements from the managed object store using 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... | |
Static Public Attributes | |
static const opflex::modb::class_id_t | CLASS_ID = 41 |
The unique class ID for FloodContext. | |
|
inline |
Construct an instance of FloodContext.
This should not typically be called from user code.
|
inline |
Get the value of multicastGroupIP if it has been set.
References isMulticastGroupIPSet().
Referenced by getMulticastGroupIP().
|
inline |
Get the value of multicastGroupIP if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getMulticastGroupIP().
|
inline |
Check whether multicastGroupIP has been set.
Referenced by getMulticastGroupIP().
|
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.
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().
|
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.
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().
|
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.
std::logic_error | if no mutator is active |
References CLASS_ID.
|
inlinestatic |
Remove the FloodContext 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.
framework | the framework instance to use |
uri | the URI of the object to remove |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
inlinestatic |
Remove the FloodContext 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.
uri | the URI of the object to remove |
std::logic_error | if no mutator is active |
|
inlinestatic |
Remove the FloodContext object with the specified path elements from the managed object store.
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.
The object URI generated by this function will take the form: /PolicyUniverse/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext
framework | the framework instance to use |
policySpaceName | the value of policySpaceName, a naming property for Space |
gbpFloodDomainName | the value of gbpFloodDomainName, a naming property for FloodDomain |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
inlinestatic |
Remove the FloodContext object with the specified path elements from the managed object store using 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.
The object URI generated by this function will take the form: /PolicyUniverse/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext
policySpaceName | the value of policySpaceName, a naming property for Space |
gbpFloodDomainName | the value of gbpFloodDomainName, a naming property for FloodDomain |
std::logic_error | if no mutator is active |
|
inlinestatic |
Retrieve an instance of FloodContext 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.
framework | the framework instance to use |
uri | the URI of the object to retrieve |
References CLASS_ID.
Referenced by resolve(), and modelgbp::gbp::FloodDomain::resolveGbpeFloodContext().
|
inlinestatic |
Retrieve an instance of FloodContext 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.
uri | the URI of the object to retrieve |
References CLASS_ID.
|
inlinestatic |
Retrieve an instance of FloodContext 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: /PolicyUniverse/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext
framework | the framework instance to use |
policySpaceName | the value of policySpaceName, a naming property for Space |
gbpFloodDomainName | the value of gbpFloodDomainName, a naming property for FloodDomain |
References resolve().
|
inlinestatic |
Retrieve an instance of FloodContext 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: /PolicyUniverse/PolicySpace/[policySpaceName]/GbpFloodDomain/[gbpFloodDomainName]/GbpeFloodContext
policySpaceName | the value of policySpaceName, a naming property for Space |
gbpFloodDomainName | the value of gbpFloodDomainName, a naming property for FloodDomain |
References resolve().
|
inline |
Set multicastGroupIP to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inlinestatic |
Unregister a listener from updates to this class.
framework | the framework instance |
listener | The listener to unregister. |
References CLASS_ID.
Referenced by unregisterListener().
|
inlinestatic |
Unregister a listener from updates to this class from the default framework instance.
listener | The listener to unregister. |
References unregisterListener().
|
inline |
Unset multicastGroupIP in the currently-active mutator.
std::logic_error | if no mutator is active |