Inheritance diagram for modelgbp::dci::EpToUnivRSrc:

Public Member Functions
bool	isRoleSet ()
	Check whether role has been set.

boost::optional< const uint8_t >	getRole ()
	Get the value of role if it has been set.

const uint8_t	getRole (const uint8_t defaultValue)
	Get the value of role if set, otherwise the value of default passed in.

modelgbp::dci::EpToUnivRSrc &	setRole (const uint8_t newValue)
	Set role to the specified value in the currently-active mutator.

modelgbp::dci::EpToUnivRSrc &	unsetRole ()
	Unset role in the currently-active mutator.

bool	isTargetSet ()
	Check whether target has been set.

boost::optional< opflex::modb::class_id_t >	getTargetClass ()
	Get the value of targetClass if it has been set.

boost::optional< opflex::modb::URI >	getTargetURI ()
	Get the value of targetURI if it has been set.

opflex::modb::class_id_t	getTargetClass (opflex::modb::class_id_t defaultValue)
	Get the value of targetClass if set, otherwise the value of default passed in.

opflex::modb::URI	getTargetURI (opflex::modb::URI defaultValue)
	Get the value of targetURI if set, otherwise the value of default passed in.

modelgbp::dci::EpToUnivRSrc &	setTargetUniverse (const opflex::modb::URI &uri)
	Set the reference to point to an instance of Universe with the specified URI.

modelgbp::dci::EpToUnivRSrc &	setTargetUniverse ()
	Set the reference to point to an instance of Universe in the currently-active mutator by constructing its URI from the path elements that lead to it.

modelgbp::dci::EpToUnivRSrc &	unsetTarget ()
	Unset target in the currently-active mutator.

bool	isTypeSet ()
	Check whether type has been set.

boost::optional< const uint8_t >	getType ()
	Get the value of type if it has been set.

const uint8_t	getType (const uint8_t defaultValue)
	Get the value of type if set, otherwise the value of default passed in.

modelgbp::dci::EpToUnivRSrc &	setType (const uint8_t newValue)
	Set type to the specified value in the currently-active mutator.

modelgbp::dci::EpToUnivRSrc &	unsetType ()
	Unset type in the currently-active mutator.

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

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

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

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

static boost::optional< OF_SHARED_PTR< modelgbp::dci::EpToUnivRSrc > >	resolve (opflex::ofcore::OFFramework &framework)
	Retrieve an instance of EpToUnivRSrc 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::EpToUnivRSrc > >	resolve ()
	Retrieve an instance of EpToUnivRSrc 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 EpToUnivRSrc object with the specified URI using the currently-active mutator.

static void	remove (const opflex::modb::URI &uri)
	Remove the EpToUnivRSrc 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 = 84
	The unique class ID for EpToUnivRSrc.

Constructor & Destructor Documentation

◆ EpToUnivRSrc()

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

inline

Construct an instance of EpToUnivRSrc.

This should not typically be called from user code.

References CLASS_ID.

Member Function Documentation

◆ getRole() [1/2]

boost::optional< const uint8_t > modelgbp::dci::EpToUnivRSrc::getRole ( )

inline

Get the value of role if it has been set.

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

References isRoleSet().

Referenced by getRole().

◆ getRole() [2/2]

const uint8_t modelgbp::dci::EpToUnivRSrc::getRole ( const uint8_t defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

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

References getRole().

◆ getTargetClass() [1/2]

boost::optional< opflex::modb::class_id_t > modelgbp::dci::EpToUnivRSrc::getTargetClass ( )

inline

Get the value of targetClass if it has been set.

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

References isTargetSet().

Referenced by getTargetClass().

◆ getTargetClass() [2/2]

opflex::modb::class_id_t modelgbp::dci::EpToUnivRSrc::getTargetClass ( opflex::modb::class_id_t defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

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

References getTargetClass().

◆ getTargetURI() [1/2]

boost::optional< opflex::modb::URI > modelgbp::dci::EpToUnivRSrc::getTargetURI ( )

inline

Get the value of targetURI if it has been set.

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

References isTargetSet().

Referenced by getTargetURI().

◆ getTargetURI() [2/2]

opflex::modb::URI modelgbp::dci::EpToUnivRSrc::getTargetURI ( opflex::modb::URI defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

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

References getTargetURI().

◆ getType() [1/2]

boost::optional< const uint8_t > modelgbp::dci::EpToUnivRSrc::getType ( )

inline

Get the value of type if it has been set.

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

References isTypeSet().

Referenced by getType().

◆ getType() [2/2]

const uint8_t modelgbp::dci::EpToUnivRSrc::getType ( const uint8_t defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

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

References getType().

◆ isRoleSet()

bool modelgbp::dci::EpToUnivRSrc::isRoleSet ( )

inline

Check whether role has been set.

Returns: true if role has been set

Referenced by getRole().

◆ isTargetSet()

bool modelgbp::dci::EpToUnivRSrc::isTargetSet ( )

inline

Check whether target has been set.

Returns: true if target has been set

Referenced by getTargetClass(), and getTargetURI().

◆ isTypeSet()

bool modelgbp::dci::EpToUnivRSrc::isTypeSet ( )

inline

Check whether type has been set.

Returns: true if type has been set

Referenced by getType().

◆ registerListener() [1/2]

static void modelgbp::dci::EpToUnivRSrc::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().

◆ registerListener() [2/2]

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

Referenced by registerListener().

◆ remove() [1/3]

void modelgbp::dci::EpToUnivRSrc::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.

Referenced by remove().

◆ remove() [2/3]

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

inlinestatic

Remove the EpToUnivRSrc 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().

◆ remove() [3/3]

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

inlinestatic

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

◆ resolve() [1/4]

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

inlinestatic

Retrieve an instance of EpToUnivRSrc 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: /DciDiscoverer/DciEp/DciEpToUnivRSrc

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

References resolve().

Referenced by resolve(), resolve(), and modelgbp::dci::Ep::resolveDciEpToUnivRSrc().

◆ resolve() [2/4]

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

inlinestatic

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

◆ resolve() [3/4]

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

inlinestatic

Retrieve an instance of EpToUnivRSrc 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: /DciDiscoverer/DciEp/DciEpToUnivRSrc

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

inlinestatic

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

◆ setRole()

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::setRole ( const uint8_t newValue )

inline

Set role 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

◆ setTargetUniverse() [1/2]

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::setTargetUniverse ( )

inline

Set the reference to point to an instance of Universe in the currently-active mutator by constructing its URI from the path elements that lead to it.

The reference URI generated by this function will take the form: /DciUniverse

Exceptions

std::logic_error if no mutator is active

Returns: a reference to the current object

See also: opflex::modb::Mutator

◆ setTargetUniverse() [2/2]

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::setTargetUniverse ( const opflex::modb::URI & uri )

inline

Set the reference to point to an instance of Universe with the specified URI.

Parameters

uri	The URI of the reference to add

Returns: a reference to the current object

Exceptions

std::logic_error if no mutator is active

See also: opflex::modb::Mutator

◆ setType()

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::setType ( const uint8_t newValue )

inline

Set type 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

◆ unregisterListener() [1/2]

static void modelgbp::dci::EpToUnivRSrc::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 unregisterListener().

◆ unregisterListener() [2/2]

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

Referenced by unregisterListener().

◆ unsetRole()

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::unsetRole ( )

inline

Unset role 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

◆ unsetTarget()

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::unsetTarget ( )

inline

Unset target 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

◆ unsetType()

modelgbp::dci::EpToUnivRSrc & modelgbp::dci::EpToUnivRSrc::unsetType ( )

inline

Unset type 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

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

EpToUnivRSrc.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ EpToUnivRSrc()

Member Function Documentation

◆ getRole() [1/2]

◆ getRole() [2/2]

◆ getTargetClass() [1/2]

◆ getTargetClass() [2/2]

◆ getTargetURI() [1/2]

◆ getTargetURI() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ isRoleSet()

◆ isTargetSet()

◆ isTypeSet()

◆ 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]

◆ setRole()

◆ setTargetUniverse() [1/2]

◆ setTargetUniverse() [2/2]

◆ setType()

◆ unregisterListener() [1/2]

◆ unregisterListener() [2/2]

◆ unsetRole()

◆ unsetTarget()

◆ unsetType()