Inheritance diagram for modelgbp::dci::Universe:

Public Member Functions
bool	isNameSet ()
	Check whether name has been set.

boost::optional< const std::string & >	getName ()
	Get the value of name if it has been set.

const std::string &	getName (const std::string &defaultValue)
	Get the value of name if set, otherwise the value of default passed in.

modelgbp::dci::Universe &	setName (const std::string &newValue)
	Set name to the specified value in the currently-active mutator.

modelgbp::dci::Universe &	unsetName ()
	Unset name in the currently-active mutator.

boost::optional< OF_SHARED_PTR< modelgbp::dci::EpFromUnivRTgt > >	resolveDciEpFromUnivRTgt ()
	Retrieve the child object with the specified naming properties.

OF_SHARED_PTR< modelgbp::dci::EpFromUnivRTgt >	addDciEpFromUnivRTgt ()
	Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

boost::optional< OF_SHARED_PTR< modelgbp::dci::Domain > >	resolveDciDomain (const std::string &dciDomainName)
	Retrieve the child object with the specified naming properties.

OF_SHARED_PTR< modelgbp::dci::Domain >	addDciDomain (const std::string &dciDomainName)
	Create a new child object with the specified naming properties and make it a child of this object in the currently-active mutator.

void	resolveDciDomain (std::vector< OF_SHARED_PTR< modelgbp::dci::Domain > > &out)
	Resolve and retrieve all of the immediate children of type modelgbp::dci::Domain.

void	remove ()
	Remove this instance using the currently-active mutator.

	Universe (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const OF_SHARED_PTR< const opflex::modb::mointernal::ObjectInstance > &oi)
	Construct an instance of Universe.

Static Public Member Functions
static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > >	resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
	Retrieve an instance of Universe from the managed object store.

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > >	resolve (const opflex::modb::URI &uri)
	Retrieve an instance of Universe from the managed object store using the default framework instance.

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > >	resolve (opflex::ofcore::OFFramework &framework)
	Retrieve an instance of Universe from the managed object store by constructing its URI from the path elements that lead to it.

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > >	resolve ()
	Retrieve an instance of Universe from the default managed object store by constructing its URI from the path elements that lead to it.

static void	remove (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
	Remove the Universe object with the specified URI using the currently-active mutator.

static void	remove (const opflex::modb::URI &uri)
	Remove the Universe object with the specified URI using the currently-active mutator and the default framework instance.

static void	registerListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
	Register a listener that will get called for changes related to this class.

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.

static void	unregisterListener (opflex::ofcore::OFFramework &framework, opflex::modb::ObjectListener *listener)
	Unregister a listener from updates to this class.

static void	unregisterListener (opflex::modb::ObjectListener *listener)
	Unregister a listener from updates to this class from the default framework instance.

Static Public Attributes
static const opflex::modb::class_id_t	CLASS_ID = 81
	The unique class ID for Universe.

Constructor & Destructor Documentation

◆ Universe()

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

inline

Construct an instance of Universe.

This should not typically be called from user code.

Member Function Documentation

◆ addDciDomain()

OF_SHARED_PTR< modelgbp::dci::Domain > modelgbp::dci::Universe::addDciDomain ( const std::string & dciDomainName )

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

dciDomainName the value of dciDomainName, a naming property for Domain

Exceptions

std::logic_error if no mutator is active

Returns: a shared pointer to the (possibly new) object

References CLASS_ID, and resolve().

◆ addDciEpFromUnivRTgt()

OF_SHARED_PTR< modelgbp::dci::EpFromUnivRTgt > modelgbp::dci::Universe::addDciEpFromUnivRTgt ( )

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_error if no mutator is active

Returns: a shared pointer to the (possibly new) object

References CLASS_ID, and resolve().

◆ getName() [1/2]

boost::optional< const std::string & > modelgbp::dci::Universe::getName ( )

inline

Get the value of name if it has been set.

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

References isNameSet(), and resolve().

Referenced by getName().

◆ getName() [2/2]

const std::string & modelgbp::dci::Universe::getName ( const std::string & defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

Returns: the value of name if set, otherwise the value of default passed in

References getName(), and resolve().

◆ isNameSet()

bool modelgbp::dci::Universe::isNameSet ( )

inline

Check whether name has been set.

Returns: true if name has been set

References resolve().

Referenced by getName().

◆ registerListener() [1/2]

static void modelgbp::dci::Universe::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

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(), and resolve().

◆ registerListener() [2/2]

static void modelgbp::dci::Universe::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

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, and resolve().

Referenced by registerListener().

◆ remove() [1/3]

void modelgbp::dci::Universe::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_error if no mutator is active

References CLASS_ID, and resolve().

Referenced by remove().

◆ remove() [2/3]

static void modelgbp::dci::Universe::remove ( const opflex::modb::URI & uri )

inlinestatic

Remove the Universe 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

uri	the URI of the object to remove

Exceptions

std::logic_error if no mutator is active

References remove(), and resolve().

◆ remove() [3/3]

static void modelgbp::dci::Universe::remove	(	opflex::ofcore::OFFramework &	framework,
		const opflex::modb::URI &	uri )

inlinestatic

Remove the Universe 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

framework	the framework instance to use
uri	the URI of the object to remove

Exceptions

std::logic_error if no mutator is active

References CLASS_ID, and resolve().

◆ resolve() [1/4]

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > > modelgbp::dci::Universe::resolve ( )

inlinestatic

Retrieve an instance of Universe 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: /DciUniverse

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

References resolve().

Referenced by addDciDomain(), addDciEpFromUnivRTgt(), getName(), getName(), isNameSet(), registerListener(), registerListener(), remove(), remove(), remove(), resolve(), resolve(), resolve(), resolve(), resolveDciDomain(), resolveDciDomain(), resolveDciEpFromUnivRTgt(), modelgbp::dmtree::Root::resolveDciUniverse(), setName(), unregisterListener(), unregisterListener(), and unsetName().

◆ resolve() [2/4]

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > > modelgbp::dci::Universe::resolve ( const opflex::modb::URI & uri )

inlinestatic

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

uri	the URI of the object to retrieve

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

References CLASS_ID, and resolve().

◆ resolve() [3/4]

static boost::optional< OF_SHARED_PTR< modelgbp::dci::Universe > > modelgbp::dci::Universe::resolve ( opflex::ofcore::OFFramework & framework )

inlinestatic

Retrieve an instance of Universe 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: /DciUniverse

Parameters

framework the framework instance to use

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::dci::Universe > > modelgbp::dci::Universe::resolve	(	opflex::ofcore::OFFramework &	framework,
		const opflex::modb::URI &	uri )

inlinestatic

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

framework	the framework instance to use
uri	the URI of the object to retrieve

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

References CLASS_ID, and resolve().

◆ resolveDciDomain() [1/2]

boost::optional< OF_SHARED_PTR< modelgbp::dci::Domain > > modelgbp::dci::Universe::resolveDciDomain ( const std::string & dciDomainName )

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

dciDomainName the value of dciDomainName, a naming property for Domain

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

References resolve(), and modelgbp::dci::Domain::resolve().

◆ resolveDciDomain() [2/2]

void modelgbp::dci::Universe::resolveDciDomain ( std::vector< OF_SHARED_PTR< modelgbp::dci::Domain > > & out )

inline

Resolve and retrieve all of the immediate children of type modelgbp::dci::Domain.

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

out	a reference to a vector that will receive the child objects.

References CLASS_ID, and resolve().

◆ resolveDciEpFromUnivRTgt()

boost::optional< OF_SHARED_PTR< modelgbp::dci::EpFromUnivRTgt > > modelgbp::dci::Universe::resolveDciEpFromUnivRTgt ( )

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::dci::EpFromUnivRTgt::resolve(), and resolve().

◆ setName()

modelgbp::dci::Universe & modelgbp::dci::Universe::setName ( const std::string & newValue )

inline

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

Parameters

newValue the new value to set.

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

References resolve().

◆ unregisterListener() [1/2]

static void modelgbp::dci::Universe::unregisterListener ( opflex::modb::ObjectListener * listener )

inlinestatic

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

Parameters

listener The listener to unregister.

References resolve(), and unregisterListener().

◆ unregisterListener() [2/2]

static void modelgbp::dci::Universe::unregisterListener	(	opflex::ofcore::OFFramework &	framework,
		opflex::modb::ObjectListener *	listener )

inlinestatic

Unregister a listener from updates to this class.

Parameters

framework	the framework instance
listener	The listener to unregister.

References CLASS_ID, and resolve().

Referenced by unregisterListener().

◆ unsetName()

modelgbp::dci::Universe & modelgbp::dci::Universe::unsetName ( )

inline

Unset name in the currently-active mutator.

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

References resolve().

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

dci/Universe.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ Universe()

Member Function Documentation

◆ addDciDomain()

◆ addDciEpFromUnivRTgt()

◆ getName() [1/2]

◆ getName() [2/2]

◆ isNameSet()

◆ registerListener() [1/2]

◆ registerListener() [2/2]

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ resolve() [1/4]

◆ resolve() [2/4]

◆ resolve() [3/4]

◆ resolve() [4/4]

◆ resolveDciDomain() [1/2]

◆ resolveDciDomain() [2/2]

◆ resolveDciEpFromUnivRTgt()

◆ setName()

◆ unregisterListener() [1/2]

◆ unregisterListener() [2/2]

◆ unsetName()