modelgbp Generated OpFlex Model  1.7.0
modelgbp::inv::DHCPv4Config Class Reference
Inheritance diagram for modelgbp::inv::DHCPv4Config:

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::DHCPv4ConfigsetDomain (const std::string &newValue)
 Set domain to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetDomain ()
 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::DHCPv4ConfigsetInterfaceMTU (uint16_t newValue)
 Set interfaceMTU to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetInterfaceMTU ()
 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::DHCPv4ConfigsetIp (const std::string &newValue)
 Set ip to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetIp ()
 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::DHCPv4ConfigsetLeaseTime (uint32_t newValue)
 Set leaseTime to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetLeaseTime ()
 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::DHCPv4ConfigsetPrefixLen (const uint8_t newValue)
 Set prefixLen to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetPrefixLen ()
 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::DHCPv4ConfigsetServerIp (const std::string &newValue)
 Set serverIp to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv4ConfigunsetServerIp ()
 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::DNSServeraddInvDNSServer (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::RouteraddInvRouter (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::StaticRouteaddInvStaticRoute (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.
 

Constructor & Destructor Documentation

◆ DHCPv4Config()

modelgbp::inv::DHCPv4Config::DHCPv4Config ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri,
const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &  oi 
)
inline

Construct an instance of DHCPv4Config.

This should not typically be called from user code.

Member Function Documentation

◆ addInvDNSServer()

OF_SHARED_PTR<modelgbp::inv::DNSServer> modelgbp::inv::DHCPv4Config::addInvDNSServer ( const std::string &  invDNSServerName)
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
invDNSServerNamethe value of invDNSServerName, a naming property for DNSServer
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvRouter()

OF_SHARED_PTR<modelgbp::inv::Router> modelgbp::inv::DHCPv4Config::addInvRouter ( const std::string &  invRouterName)
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
invRouterNamethe value of invRouterName, a naming property for Router
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ addInvStaticRoute()

OF_SHARED_PTR<modelgbp::inv::StaticRoute> modelgbp::inv::DHCPv4Config::addInvStaticRoute ( const std::string &  invStaticRouteDest,
const uint8_t  invStaticRoutePrefixLen,
const std::string &  invStaticRouteNextHop 
)
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
invStaticRouteDestthe value of invStaticRouteDest, a naming property for StaticRoute
invStaticRoutePrefixLenthe value of invStaticRoutePrefixLen, a naming property for StaticRoute
invStaticRouteNextHopthe value of invStaticRouteNextHop, a naming property for StaticRoute
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

◆ getDomain() [1/2]

boost::optional<const std::string&> modelgbp::inv::DHCPv4Config::getDomain ( )
inline

Get the value of domain if it has been set.

Returns
the value of domain or boost::none if not set

References isDomainSet().

Referenced by getDomain().

◆ getDomain() [2/2]

const std::string& modelgbp::inv::DHCPv4Config::getDomain ( const std::string &  defaultValue)
inline

Get the value of domain if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of domain if set, otherwise the value of default passed in

References getDomain().

◆ getInterfaceMTU() [1/2]

boost::optional<uint16_t> modelgbp::inv::DHCPv4Config::getInterfaceMTU ( )
inline

Get the value of interfaceMTU if it has been set.

Returns
the value of interfaceMTU or boost::none if not set

References isInterfaceMTUSet().

Referenced by getInterfaceMTU().

◆ getInterfaceMTU() [2/2]

uint16_t modelgbp::inv::DHCPv4Config::getInterfaceMTU ( uint16_t  defaultValue)
inline

Get the value of interfaceMTU if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of interfaceMTU if set, otherwise the value of default passed in

References getInterfaceMTU().

◆ getIp() [1/2]

boost::optional<const std::string&> modelgbp::inv::DHCPv4Config::getIp ( )
inline

Get the value of ip if it has been set.

Returns
the value of ip or boost::none if not set

References isIpSet().

Referenced by getIp().

◆ getIp() [2/2]

const std::string& modelgbp::inv::DHCPv4Config::getIp ( const std::string &  defaultValue)
inline

Get the value of ip if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of ip if set, otherwise the value of default passed in

References getIp().

◆ getLeaseTime() [1/2]

boost::optional<uint32_t> modelgbp::inv::DHCPv4Config::getLeaseTime ( )
inline

Get the value of leaseTime if it has been set.

Returns
the value of leaseTime or boost::none if not set

References isLeaseTimeSet().

Referenced by getLeaseTime().

◆ getLeaseTime() [2/2]

uint32_t modelgbp::inv::DHCPv4Config::getLeaseTime ( uint32_t  defaultValue)
inline

Get the value of leaseTime if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of leaseTime if set, otherwise the value of default passed in

References getLeaseTime().

◆ getPrefixLen() [1/2]

boost::optional<const uint8_t> modelgbp::inv::DHCPv4Config::getPrefixLen ( )
inline

Get the value of prefixLen if it has been set.

Returns
the value of prefixLen or boost::none if not set

References isPrefixLenSet().

Referenced by getPrefixLen().

◆ getPrefixLen() [2/2]

const uint8_t modelgbp::inv::DHCPv4Config::getPrefixLen ( const uint8_t  defaultValue)
inline

Get the value of prefixLen if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of prefixLen if set, otherwise the value of default passed in

References getPrefixLen().

◆ getServerIp() [1/2]

boost::optional<const std::string&> modelgbp::inv::DHCPv4Config::getServerIp ( )
inline

Get the value of serverIp if it has been set.

Returns
the value of serverIp or boost::none if not set

References isServerIpSet().

Referenced by getServerIp().

◆ getServerIp() [2/2]

const std::string& modelgbp::inv::DHCPv4Config::getServerIp ( const std::string &  defaultValue)
inline

Get the value of serverIp if set, otherwise the value of default passed in.

Parameters
defaultValuedefault value returned if the property is not set
Returns
the value of serverIp if set, otherwise the value of default passed in

References getServerIp().

◆ isDomainSet()

bool modelgbp::inv::DHCPv4Config::isDomainSet ( )
inline

Check whether domain has been set.

Returns
true if domain has been set

Referenced by getDomain().

◆ isInterfaceMTUSet()

bool modelgbp::inv::DHCPv4Config::isInterfaceMTUSet ( )
inline

Check whether interfaceMTU has been set.

Returns
true if interfaceMTU has been set

Referenced by getInterfaceMTU().

◆ isIpSet()

bool modelgbp::inv::DHCPv4Config::isIpSet ( )
inline

Check whether ip has been set.

Returns
true if ip has been set

Referenced by getIp().

◆ isLeaseTimeSet()

bool modelgbp::inv::DHCPv4Config::isLeaseTimeSet ( )
inline

Check whether leaseTime has been set.

Returns
true if leaseTime has been set

Referenced by getLeaseTime().

◆ isPrefixLenSet()

bool modelgbp::inv::DHCPv4Config::isPrefixLenSet ( )
inline

Check whether prefixLen has been set.

Returns
true if prefixLen has been set

Referenced by getPrefixLen().

◆ isServerIpSet()

bool modelgbp::inv::DHCPv4Config::isServerIpSet ( )
inline

Check whether serverIp has been set.

Returns
true if serverIp has been set

Referenced by getServerIp().

◆ registerListener() [1/2]

static void modelgbp::inv::DHCPv4Config::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
frameworkthe framework instance
listenerthe 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::inv::DHCPv4Config::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
listenerthe 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/5]

void modelgbp::inv::DHCPv4Config::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_errorif no mutator is active

References CLASS_ID.

◆ remove() [2/5]

static void modelgbp::inv::DHCPv4Config::remove ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
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.

Parameters
frameworkthe framework instance to use
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [3/5]

static void modelgbp::inv::DHCPv4Config::remove ( const opflex::modb::URI &  uri)
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.

Parameters
urithe URI of the object to remove
Exceptions
std::logic_errorif no mutator is active

◆ remove() [4/5]

static void modelgbp::inv::DHCPv4Config::remove ( opflex::ofcore::OFFramework &  framework,
const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
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

Parameters
frameworkthe framework instance to use
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

◆ remove() [5/5]

static void modelgbp::inv::DHCPv4Config::remove ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
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

Parameters
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
Exceptions
std::logic_errorif no mutator is active

◆ resolve() [1/4]

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv4Config> > modelgbp::inv::DHCPv4Config::resolve ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
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.

Parameters
frameworkthe framework instance to use
urithe URI of the object to retrieve
Returns
a shared pointer to the object or boost::none if it does not exist.

References CLASS_ID.

Referenced by resolve(), and modelgbp::inv::LocalInventoryEp::resolveInvDHCPv4Config().

◆ resolve() [2/4]

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv4Config> > modelgbp::inv::DHCPv4Config::resolve ( const opflex::modb::URI &  uri)
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.

Parameters
urithe 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::inv::DHCPv4Config> > modelgbp::inv::DHCPv4Config::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
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

Parameters
frameworkthe framework instance to use
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolve() [4/4]

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv4Config> > modelgbp::inv::DHCPv4Config::resolve ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
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

Parameters
invLocalEndpointInventoryNamethe value of invLocalEndpointInventoryName, a naming property for LocalEndpointInventory
invLocalInventoryEpUuidthe value of invLocalInventoryEpUuid, a naming property for LocalInventoryEp
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

◆ resolveInvDNSServer() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::inv::DNSServer> > modelgbp::inv::DHCPv4Config::resolveInvDNSServer ( const std::string &  invDNSServerName)
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
invDNSServerNamethe value of invDNSServerName, a naming property for DNSServer
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::DNSServer::resolve().

◆ resolveInvDNSServer() [2/2]

void modelgbp::inv::DHCPv4Config::resolveInvDNSServer ( std::vector< OF_SHARED_PTR< modelgbp::inv::DNSServer > > &  out)
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.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveInvRouter() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::inv::Router> > modelgbp::inv::DHCPv4Config::resolveInvRouter ( const std::string &  invRouterName)
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
invRouterNamethe value of invRouterName, a naming property for Router
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::Router::resolve().

◆ resolveInvRouter() [2/2]

void modelgbp::inv::DHCPv4Config::resolveInvRouter ( std::vector< OF_SHARED_PTR< modelgbp::inv::Router > > &  out)
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.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ resolveInvStaticRoute() [1/2]

boost::optional<OF_SHARED_PTR<modelgbp::inv::StaticRoute> > modelgbp::inv::DHCPv4Config::resolveInvStaticRoute ( const std::string &  invStaticRouteDest,
const uint8_t  invStaticRoutePrefixLen,
const std::string &  invStaticRouteNextHop 
)
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
invStaticRouteDestthe value of invStaticRouteDest, a naming property for StaticRoute
invStaticRoutePrefixLenthe value of invStaticRoutePrefixLen, a naming property for StaticRoute
invStaticRouteNextHopthe value of invStaticRouteNextHop, a naming property for StaticRoute
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::inv::StaticRoute::resolve().

◆ resolveInvStaticRoute() [2/2]

void modelgbp::inv::DHCPv4Config::resolveInvStaticRoute ( std::vector< OF_SHARED_PTR< modelgbp::inv::StaticRoute > > &  out)
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.

Parameters
outa reference to a vector that will receive the child objects.

References CLASS_ID.

◆ setDomain()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setDomain ( const std::string &  newValue)
inline

Set domain to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setInterfaceMTU()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setInterfaceMTU ( uint16_t  newValue)
inline

Set interfaceMTU to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setIp()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setIp ( const std::string &  newValue)
inline

Set ip to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setLeaseTime()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setLeaseTime ( uint32_t  newValue)
inline

Set leaseTime to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setPrefixLen()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setPrefixLen ( const uint8_t  newValue)
inline

Set prefixLen to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ setServerIp()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::setServerIp ( const std::string &  newValue)
inline

Set serverIp to the specified value in the currently-active mutator.

Parameters
newValuethe new value to set.
Returns
a reference to the current object
Exceptions
std::logic_errorif no mutator is active
See also
opflex::modb::Mutator

◆ unregisterListener() [1/2]

static void modelgbp::inv::DHCPv4Config::unregisterListener ( opflex::ofcore::OFFramework &  framework,
opflex::modb::ObjectListener *  listener 
)
inlinestatic

Unregister a listener from updates to this class.

Parameters
frameworkthe framework instance
listenerThe listener to unregister.

References CLASS_ID.

Referenced by unregisterListener().

◆ unregisterListener() [2/2]

static void modelgbp::inv::DHCPv4Config::unregisterListener ( opflex::modb::ObjectListener *  listener)
inlinestatic

Unregister a listener from updates to this class from the default framework instance.

Parameters
listenerThe listener to unregister.

References unregisterListener().

◆ unsetDomain()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetDomain ( )
inline

Unset domain in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetInterfaceMTU()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetInterfaceMTU ( )
inline

Unset interfaceMTU in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetIp()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetIp ( )
inline

Unset ip in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetLeaseTime()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetLeaseTime ( )
inline

Unset leaseTime in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetPrefixLen()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetPrefixLen ( )
inline

Unset prefixLen in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

◆ unsetServerIp()

modelgbp::inv::DHCPv4Config& modelgbp::inv::DHCPv4Config::unsetServerIp ( )
inline

Unset serverIp in the currently-active mutator.

Exceptions
std::logic_errorif no mutator is active
Returns
a reference to the current object
See also
opflex::modb::Mutator

The documentation for this class was generated from the following file: