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

Public Member Functions

bool isPreferredLifetimeSet ()
 Check whether preferredLifetime has been set. More...
 
boost::optional< uint32_t > getPreferredLifetime ()
 Get the value of preferredLifetime if it has been set. More...
 
uint32_t getPreferredLifetime (uint32_t defaultValue)
 Get the value of preferredLifetime if set, otherwise the value of default passed in. More...
 
modelgbp::inv::DHCPv6ConfigsetPreferredLifetime (uint32_t newValue)
 Set preferredLifetime to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv6ConfigunsetPreferredLifetime ()
 Unset preferredLifetime in the currently-active mutator. More...
 
bool isT1Set ()
 Check whether t1 has been set. More...
 
boost::optional< uint32_t > getT1 ()
 Get the value of t1 if it has been set. More...
 
uint32_t getT1 (uint32_t defaultValue)
 Get the value of t1 if set, otherwise the value of default passed in. More...
 
modelgbp::inv::DHCPv6ConfigsetT1 (uint32_t newValue)
 Set t1 to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv6ConfigunsetT1 ()
 Unset t1 in the currently-active mutator. More...
 
bool isT2Set ()
 Check whether t2 has been set. More...
 
boost::optional< uint32_t > getT2 ()
 Get the value of t2 if it has been set. More...
 
uint32_t getT2 (uint32_t defaultValue)
 Get the value of t2 if set, otherwise the value of default passed in. More...
 
modelgbp::inv::DHCPv6ConfigsetT2 (uint32_t newValue)
 Set t2 to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv6ConfigunsetT2 ()
 Unset t2 in the currently-active mutator. More...
 
bool isValidLifetimeSet ()
 Check whether validLifetime has been set. More...
 
boost::optional< uint32_t > getValidLifetime ()
 Get the value of validLifetime if it has been set. More...
 
uint32_t getValidLifetime (uint32_t defaultValue)
 Get the value of validLifetime if set, otherwise the value of default passed in. More...
 
modelgbp::inv::DHCPv6ConfigsetValidLifetime (uint32_t newValue)
 Set validLifetime to the specified value in the currently-active mutator. More...
 
modelgbp::inv::DHCPv6ConfigunsetValidLifetime ()
 Unset validLifetime 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::SearchListEntry > > 
resolveInvSearchListEntry (const std::string &invSearchListEntryName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::inv::SearchListEntry
addInvSearchListEntry (const std::string &invSearchListEntryName)
 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 resolveInvSearchListEntry (std::vector< OF_SHARED_PTR< modelgbp::inv::SearchListEntry > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::inv::SearchListEntry. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 DHCPv6Config (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of DHCPv6Config. More...
 

Static Public Member Functions

static boost::optional
< OF_SHARED_PTR
< modelgbp::inv::DHCPv6Config > > 
resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of DHCPv6Config from the managed object store. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::inv::DHCPv6Config > > 
resolve (const opflex::modb::URI &uri)
 Retrieve an instance of DHCPv6Config from the managed object store using the default framework instance. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::inv::DHCPv6Config > > 
resolve (opflex::ofcore::OFFramework &framework, const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid)
 Retrieve an instance of DHCPv6Config 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::DHCPv6Config > > 
resolve (const std::string &invLocalEndpointInventoryName, const std::string &invLocalInventoryEpUuid)
 Retrieve an instance of DHCPv6Config 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 DHCPv6Config object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the DHCPv6Config 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 DHCPv6Config 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 DHCPv6Config 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 = 134
 The unique class ID for DHCPv6Config.
 

Constructor & Destructor Documentation

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

Construct an instance of DHCPv6Config.

This should not typically be called from user code.

Member Function Documentation

OF_SHARED_PTR<modelgbp::inv::DNSServer> modelgbp::inv::DHCPv6Config::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.

OF_SHARED_PTR<modelgbp::inv::SearchListEntry> modelgbp::inv::DHCPv6Config::addInvSearchListEntry ( const std::string &  invSearchListEntryName)
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
invSearchListEntryNamethe value of invSearchListEntryName, a naming property for SearchListEntry
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

boost::optional<uint32_t> modelgbp::inv::DHCPv6Config::getPreferredLifetime ( )
inline

Get the value of preferredLifetime if it has been set.

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

References isPreferredLifetimeSet().

Referenced by getPreferredLifetime().

uint32_t modelgbp::inv::DHCPv6Config::getPreferredLifetime ( uint32_t  defaultValue)
inline

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

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

References getPreferredLifetime().

boost::optional<uint32_t> modelgbp::inv::DHCPv6Config::getT1 ( )
inline

Get the value of t1 if it has been set.

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

References isT1Set().

Referenced by getT1().

uint32_t modelgbp::inv::DHCPv6Config::getT1 ( uint32_t  defaultValue)
inline

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

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

References getT1().

boost::optional<uint32_t> modelgbp::inv::DHCPv6Config::getT2 ( )
inline

Get the value of t2 if it has been set.

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

References isT2Set().

Referenced by getT2().

uint32_t modelgbp::inv::DHCPv6Config::getT2 ( uint32_t  defaultValue)
inline

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

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

References getT2().

boost::optional<uint32_t> modelgbp::inv::DHCPv6Config::getValidLifetime ( )
inline

Get the value of validLifetime if it has been set.

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

References isValidLifetimeSet().

Referenced by getValidLifetime().

uint32_t modelgbp::inv::DHCPv6Config::getValidLifetime ( uint32_t  defaultValue)
inline

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

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

References getValidLifetime().

bool modelgbp::inv::DHCPv6Config::isPreferredLifetimeSet ( )
inline

Check whether preferredLifetime has been set.

Returns
true if preferredLifetime has been set

Referenced by getPreferredLifetime().

bool modelgbp::inv::DHCPv6Config::isT1Set ( )
inline

Check whether t1 has been set.

Returns
true if t1 has been set

Referenced by getT1().

bool modelgbp::inv::DHCPv6Config::isT2Set ( )
inline

Check whether t2 has been set.

Returns
true if t2 has been set

Referenced by getT2().

bool modelgbp::inv::DHCPv6Config::isValidLifetimeSet ( )
inline

Check whether validLifetime has been set.

Returns
true if validLifetime has been set

Referenced by getValidLifetime().

static void modelgbp::inv::DHCPv6Config::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().

static void modelgbp::inv::DHCPv6Config::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().

void modelgbp::inv::DHCPv6Config::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.

static void modelgbp::inv::DHCPv6Config::remove ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

Remove the DHCPv6Config 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.

static void modelgbp::inv::DHCPv6Config::remove ( const opflex::modb::URI &  uri)
inlinestatic

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

Remove the DHCPv6Config 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]/InvDHCPv6Config

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.

static void modelgbp::inv::DHCPv6Config::remove ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
inlinestatic

Remove the DHCPv6Config 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]/InvDHCPv6Config

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

Retrieve an instance of DHCPv6Config 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::resolveInvDHCPv6Config().

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv6Config> > modelgbp::inv::DHCPv6Config::resolve ( const opflex::modb::URI &  uri)
inlinestatic

Retrieve an instance of DHCPv6Config 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.

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv6Config> > modelgbp::inv::DHCPv6Config::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
inlinestatic

Retrieve an instance of DHCPv6Config 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]/InvDHCPv6Config

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().

static boost::optional<OF_SHARED_PTR<modelgbp::inv::DHCPv6Config> > modelgbp::inv::DHCPv6Config::resolve ( const std::string &  invLocalEndpointInventoryName,
const std::string &  invLocalInventoryEpUuid 
)
inlinestatic

Retrieve an instance of DHCPv6Config 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]/InvDHCPv6Config

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().

boost::optional<OF_SHARED_PTR<modelgbp::inv::DNSServer> > modelgbp::inv::DHCPv6Config::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().

void modelgbp::inv::DHCPv6Config::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.

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

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

void modelgbp::inv::DHCPv6Config::resolveInvSearchListEntry ( std::vector< OF_SHARED_PTR< modelgbp::inv::SearchListEntry > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::inv::SearchListEntry.

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.

modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::setPreferredLifetime ( uint32_t  newValue)
inline

Set preferredLifetime 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::setT1 ( uint32_t  newValue)
inline

Set t1 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::setT2 ( uint32_t  newValue)
inline

Set t2 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::setValidLifetime ( uint32_t  newValue)
inline

Set validLifetime 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
static void modelgbp::inv::DHCPv6Config::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().

static void modelgbp::inv::DHCPv6Config::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().

modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::unsetPreferredLifetime ( )
inline

Unset preferredLifetime 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::unsetT1 ( )
inline

Unset t1 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::unsetT2 ( )
inline

Unset t2 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
modelgbp::inv::DHCPv6Config& modelgbp::inv::DHCPv6Config::unsetValidLifetime ( )
inline

Unset validLifetime 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: