modelgbp Generated OpFlex Model
1.7.0
|
Public Member Functions | |
bool | isDomainSet () |
Check whether domain has been set. More... | |
boost::optional< const std::string & > | getDomain () |
Get the value of domain if it has been set. More... | |
const std::string & | getDomain (const std::string &defaultValue) |
Get the value of domain if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setDomain (const std::string &newValue) |
Set domain to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetDomain () |
Unset domain in the currently-active mutator. More... | |
bool | isInterfaceMTUSet () |
Check whether interfaceMTU has been set. More... | |
boost::optional< uint16_t > | getInterfaceMTU () |
Get the value of interfaceMTU if it has been set. More... | |
uint16_t | getInterfaceMTU (uint16_t defaultValue) |
Get the value of interfaceMTU if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setInterfaceMTU (uint16_t newValue) |
Set interfaceMTU to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetInterfaceMTU () |
Unset interfaceMTU in the currently-active mutator. More... | |
bool | isIpSet () |
Check whether ip has been set. More... | |
boost::optional< const std::string & > | getIp () |
Get the value of ip if it has been set. More... | |
const std::string & | getIp (const std::string &defaultValue) |
Get the value of ip if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setIp (const std::string &newValue) |
Set ip to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetIp () |
Unset ip in the currently-active mutator. More... | |
bool | isLeaseTimeSet () |
Check whether leaseTime has been set. More... | |
boost::optional< uint32_t > | getLeaseTime () |
Get the value of leaseTime if it has been set. More... | |
uint32_t | getLeaseTime (uint32_t defaultValue) |
Get the value of leaseTime if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setLeaseTime (uint32_t newValue) |
Set leaseTime to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetLeaseTime () |
Unset leaseTime in the currently-active mutator. More... | |
bool | isPrefixLenSet () |
Check whether prefixLen has been set. More... | |
boost::optional< const uint8_t > | getPrefixLen () |
Get the value of prefixLen if it has been set. More... | |
const uint8_t | getPrefixLen (const uint8_t defaultValue) |
Get the value of prefixLen if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setPrefixLen (const uint8_t newValue) |
Set prefixLen to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetPrefixLen () |
Unset prefixLen in the currently-active mutator. More... | |
bool | isServerIpSet () |
Check whether serverIp has been set. More... | |
boost::optional< const std::string & > | getServerIp () |
Get the value of serverIp if it has been set. More... | |
const std::string & | getServerIp (const std::string &defaultValue) |
Get the value of serverIp if set, otherwise the value of default passed in. More... | |
modelgbp::inv::DHCPv4Config & | setServerIp (const std::string &newValue) |
Set serverIp to the specified value in the currently-active mutator. More... | |
modelgbp::inv::DHCPv4Config & | unsetServerIp () |
Unset serverIp in the currently-active mutator. More... | |
boost::optional< OF_SHARED_PTR < modelgbp::inv::DNSServer > > | resolveInvDNSServer (const std::string &invDNSServerName) |
Retrieve the child object with the specified naming properties. More... | |
OF_SHARED_PTR < modelgbp::inv::DNSServer > | addInvDNSServer (const std::string &invDNSServerName) |
Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More... | |
void | resolveInvDNSServer (std::vector< OF_SHARED_PTR< modelgbp::inv::DNSServer > > &out) |
Resolve and retrieve all of the immediate children of type modelgbp::inv::DNSServer. More... | |
boost::optional< OF_SHARED_PTR < modelgbp::inv::Router > > | resolveInvRouter (const std::string &invRouterName) |
Retrieve the child object with the specified naming properties. More... | |
OF_SHARED_PTR < modelgbp::inv::Router > | addInvRouter (const std::string &invRouterName) |
Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More... | |
void | resolveInvRouter (std::vector< OF_SHARED_PTR< modelgbp::inv::Router > > &out) |
Resolve and retrieve all of the immediate children of type modelgbp::inv::Router. More... | |
boost::optional< OF_SHARED_PTR < modelgbp::inv::StaticRoute > > | resolveInvStaticRoute (const std::string &invStaticRouteDest, const uint8_t invStaticRoutePrefixLen, const std::string &invStaticRouteNextHop) |
Retrieve the child object with the specified naming properties. More... | |
OF_SHARED_PTR < modelgbp::inv::StaticRoute > | addInvStaticRoute (const std::string &invStaticRouteDest, const uint8_t invStaticRoutePrefixLen, const std::string &invStaticRouteNextHop) |
Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More... | |
void | resolveInvStaticRoute (std::vector< OF_SHARED_PTR< modelgbp::inv::StaticRoute > > &out) |
Resolve and retrieve all of the immediate children of type modelgbp::inv::StaticRoute. More... | |
void | remove () |
Remove this instance using the currently-active mutator. More... | |
DHCPv4Config (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi) | |
Construct an instance of DHCPv4Config. More... | |
Static Public Member Functions | |
static boost::optional < OF_SHARED_PTR < modelgbp::inv::DHCPv4Config > > | resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri) |
Retrieve an instance of DHCPv4Config from the managed object store. More... | |
static boost::optional < OF_SHARED_PTR < modelgbp::inv::DHCPv4Config > > | resolve (const opflex::modb::URI &uri) |
Retrieve an instance of DHCPv4Config from the managed object store using the default framework instance. More... | |
static boost::optional < OF_SHARED_PTR < modelgbp::inv::DHCPv4Config > > | resolve (opflex::ofcore::OFFramework &framework, const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid) |
Retrieve an instance of DHCPv4Config 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::inv::DHCPv4Config > > | resolve (const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid) |
Retrieve an instance of DHCPv4Config 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 DHCPv4Config object with the specified URI using the currently-active mutator. More... | |
static void | remove (const opflex::modb::URI &uri) |
Remove the DHCPv4Config 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 &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid) |
Remove the DHCPv4Config object with the specified path elements from the managed object store. More... | |
static void | remove (const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid) |
Remove the DHCPv4Config 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 = 130 |
The unique class ID for DHCPv4Config. | |
|
inline |
Construct an instance of DHCPv4Config.
This should not typically be called from user code.
|
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.
invDNSServerName | the value of invDNSServerName, a naming property for DNSServer |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
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.
invRouterName | the value of invRouterName, a naming property for Router |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
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.
invStaticRouteDest | the value of invStaticRouteDest, a naming property for StaticRoute |
invStaticRoutePrefixLen | the value of invStaticRoutePrefixLen, a naming property for StaticRoute |
invStaticRouteNextHop | the value of invStaticRouteNextHop, a naming property for StaticRoute |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
inline |
Get the value of domain if it has been set.
References isDomainSet().
Referenced by getDomain().
|
inline |
Get the value of domain if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getDomain().
|
inline |
Get the value of interfaceMTU if it has been set.
References isInterfaceMTUSet().
Referenced by getInterfaceMTU().
|
inline |
Get the value of interfaceMTU if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getInterfaceMTU().
|
inline |
|
inline |
Get the value of ip if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getIp().
|
inline |
Get the value of leaseTime if it has been set.
References isLeaseTimeSet().
Referenced by getLeaseTime().
|
inline |
Get the value of leaseTime if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getLeaseTime().
|
inline |
Get the value of prefixLen if it has been set.
References isPrefixLenSet().
Referenced by getPrefixLen().
|
inline |
Get the value of prefixLen if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getPrefixLen().
|
inline |
Get the value of serverIp if it has been set.
References isServerIpSet().
Referenced by getServerIp().
|
inline |
Get the value of serverIp if set, otherwise the value of default passed in.
defaultValue | default value returned if the property is not set |
References getServerIp().
|
inline |
|
inline |
Check whether interfaceMTU has been set.
Referenced by getInterfaceMTU().
|
inline |
|
inline |
Check whether leaseTime has been set.
Referenced by getLeaseTime().
|
inline |
Check whether prefixLen has been set.
Referenced by getPrefixLen().
|
inline |
Check whether serverIp has been set.
Referenced by getServerIp().
|
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 DHCPv4Config 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 DHCPv4Config 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 DHCPv4Config 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvDHCPv4Config
framework | the framework instance to use |
invLocalEndpointInventoryName | the value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory |
invLocalInventoryEpUuid | the value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp |
std::logic_error | if no mutator is active |
References CLASS_ID.
|
inlinestatic |
Remove the DHCPv4Config 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvDHCPv4Config
invLocalEndpointInventoryName | the value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory |
invLocalInventoryEpUuid | the value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp |
std::logic_error | if no mutator is active |
|
inlinestatic |
Retrieve an instance of DHCPv4Config 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::inv::LocalInventoryEp::resolveInvDHCPv4Config().
|
inlinestatic |
Retrieve an instance of DHCPv4Config 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 DHCPv4Config 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvDHCPv4Config
framework | the framework instance to use |
invLocalEndpointInventoryName | the value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory |
invLocalInventoryEpUuid | the value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp |
References resolve().
|
inlinestatic |
Retrieve an instance of DHCPv4Config 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: /InvUniverse/InvLocalEndpointInventory/[invLocalEndpointInventoryName]/InvLocalInventoryEp/[invLocalInventoryEpUuid]/InvDHCPv4Config
invLocalEndpointInventoryName | the value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory |
invLocalInventoryEpUuid | the value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp |
References resolve().
|
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.
invDNSServerName | the value of invDNSServerName, a naming property for DNSServer |
References modelgbp::inv::DNSServer::resolve().
|
inline |
Resolve and retrieve all of the immediate children of type modelgbp::inv::DNSServer.
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.
out | a reference to a vector that will receive the child objects. |
References CLASS_ID.
|
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.
invRouterName | the value of invRouterName, a naming property for Router |
References modelgbp::inv::Router::resolve().
|
inline |
Resolve and retrieve all of the immediate children of type modelgbp::inv::Router.
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.
out | a reference to a vector that will receive the child objects. |
References CLASS_ID.
|
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.
invStaticRouteDest | the value of invStaticRouteDest, a naming property for StaticRoute |
invStaticRoutePrefixLen | the value of invStaticRoutePrefixLen, a naming property for StaticRoute |
invStaticRouteNextHop | the value of invStaticRouteNextHop, a naming property for StaticRoute |
References modelgbp::inv::StaticRoute::resolve().
|
inline |
Resolve and retrieve all of the immediate children of type modelgbp::inv::StaticRoute.
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.
out | a reference to a vector that will receive the child objects. |
References CLASS_ID.
|
inline |
Set domain to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inline |
Set interfaceMTU to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inline |
Set ip to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inline |
Set leaseTime to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inline |
Set prefixLen to the specified value in the currently-active mutator.
newValue | the new value to set. |
std::logic_error | if no mutator is active |
|
inline |
Set serverIp 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 domain in the currently-active mutator.
std::logic_error | if no mutator is active |
|
inline |
Unset interfaceMTU in the currently-active mutator.
std::logic_error | if no mutator is active |
|
inline |
Unset ip in the currently-active mutator.
std::logic_error | if no mutator is active |
|
inline |
Unset leaseTime in the currently-active mutator.
std::logic_error | if no mutator is active |
|
inline |
Unset prefixLen in the currently-active mutator.
std::logic_error | if no mutator is active |
|
inline |
Unset serverIp in the currently-active mutator.
std::logic_error | if no mutator is active |