modelgbp Generated OpFlex Model  1.7.0
modelgbp::domain::Config Class Reference
Inheritance diagram for modelgbp::domain::Config:

Public Member Functions

boost::optional< OF_SHARED_PTR
< modelgbp::domain::ConfigToConfigRSrc > > 
resolveDomainConfigToConfigRSrc ()
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::domain::ConfigToConfigRSrc
addDomainConfigToConfigRSrc ()
 Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator. More...
 
boost::optional< OF_SHARED_PTR
< modelgbp::domain::ConfigToEndpointInventoryRSrc > > 
resolveDomainConfigToEndpointInventoryRSrc (const std::string &domainConfigToEndpointInventoryRSrcTargetName)
 Retrieve the child object with the specified naming properties. More...
 
OF_SHARED_PTR
< modelgbp::domain::ConfigToEndpointInventoryRSrc
addDomainConfigToEndpointInventoryRSrc (const std::string &domainConfigToEndpointInventoryRSrcTargetName)
 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 resolveDomainConfigToEndpointInventoryRSrc (std::vector< OF_SHARED_PTR< modelgbp::domain::ConfigToEndpointInventoryRSrc > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::domain::ConfigToEndpointInventoryRSrc. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 Config (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of Config. More...
 

Static Public Member Functions

static boost::optional
< OF_SHARED_PTR
< modelgbp::domain::Config > > 
resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of Config from the managed object store. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::domain::Config > > 
resolve (const opflex::modb::URI &uri)
 Retrieve an instance of Config from the managed object store using the default framework instance. More...
 
static boost::optional
< OF_SHARED_PTR
< modelgbp::domain::Config > > 
resolve (opflex::ofcore::OFFramework &framework)
 Retrieve an instance of Config 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::domain::Config > > 
resolve ()
 Retrieve an instance of Config 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 Config object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the Config 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...
 

Static Public Attributes

static const
opflex::modb::class_id_t 
CLASS_ID = 56
 The unique class ID for Config.
 

Constructor & Destructor Documentation

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

Construct an instance of Config.

This should not typically be called from user code.

Member Function Documentation

OF_SHARED_PTR<modelgbp::domain::ConfigToConfigRSrc> modelgbp::domain::Config::addDomainConfigToConfigRSrc ( )
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.

Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

OF_SHARED_PTR<modelgbp::domain::ConfigToEndpointInventoryRSrc> modelgbp::domain::Config::addDomainConfigToEndpointInventoryRSrc ( const std::string &  domainConfigToEndpointInventoryRSrcTargetName)
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
domainConfigToEndpointInventoryRSrcTargetClassthe value of domainConfigToEndpointInventoryRSrcTargetClass, a naming property for ConfigToEndpointInventoryRSrc
domainConfigToEndpointInventoryRSrcTargetNamethe value of domainConfigToEndpointInventoryRSrcTargetName, a naming property for ConfigToEndpointInventoryRSrc
Exceptions
std::logic_errorif no mutator is active
Returns
a shared pointer to the (possibly new) object

References CLASS_ID.

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

Remove the Config 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::domain::Config::remove ( const opflex::modb::URI &  uri)
inlinestatic

Remove the Config 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 boost::optional<OF_SHARED_PTR<modelgbp::domain::Config> > modelgbp::domain::Config::resolve ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

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

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

Retrieve an instance of Config 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::domain::Config> > modelgbp::domain::Config::resolve ( opflex::ofcore::OFFramework &  framework)
inlinestatic

Retrieve an instance of Config 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: /DomainConfig

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

References resolve().

static boost::optional<OF_SHARED_PTR<modelgbp::domain::Config> > modelgbp::domain::Config::resolve ( )
inlinestatic

Retrieve an instance of Config 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: /DomainConfig

Returns
a shared pointer to the object or boost::none if it does not exist.

Referenced by resolve(), and modelgbp::dmtree::Root::resolveDomainConfig().

boost::optional<OF_SHARED_PTR<modelgbp::domain::ConfigToConfigRSrc> > modelgbp::domain::Config::resolveDomainConfigToConfigRSrc ( )
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.

Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::domain::ConfigToConfigRSrc::resolve().

boost::optional<OF_SHARED_PTR<modelgbp::domain::ConfigToEndpointInventoryRSrc> > modelgbp::domain::Config::resolveDomainConfigToEndpointInventoryRSrc ( const std::string &  domainConfigToEndpointInventoryRSrcTargetName)
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
domainConfigToEndpointInventoryRSrcTargetClassthe value of domainConfigToEndpointInventoryRSrcTargetClass, a naming property for ConfigToEndpointInventoryRSrc
domainConfigToEndpointInventoryRSrcTargetNamethe value of domainConfigToEndpointInventoryRSrcTargetName, a naming property for ConfigToEndpointInventoryRSrc
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::domain::ConfigToEndpointInventoryRSrc::resolve().

void modelgbp::domain::Config::resolveDomainConfigToEndpointInventoryRSrc ( std::vector< OF_SHARED_PTR< modelgbp::domain::ConfigToEndpointInventoryRSrc > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::domain::ConfigToEndpointInventoryRSrc.

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.

static void modelgbp::domain::Config::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::domain::Config::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().


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