Inheritance diagram for modelgbp::inv::RemoteIp:

Public Member Functions
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::RemoteIp &	setIp (const std::string &newValue)
	Set ip to the specified value in the currently-active mutator. More...

modelgbp::inv::RemoteIp &	unsetIp ()
	Unset ip in the currently-active mutator. More...

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

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

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

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

static boost::optional < OF_SHARED_PTR < modelgbp::inv::RemoteIp > >	resolve (opflex::ofcore::OFFramework &framework, const std::string &invRemoteInventoryEpUuid, const std::string &invRemoteIpIp)
	Retrieve an instance of RemoteIp 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::RemoteIp > >	resolve (const std::string &invRemoteInventoryEpUuid, const std::string &invRemoteIpIp)
	Retrieve an instance of RemoteIp 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 RemoteIp object with the specified URI using the currently-active mutator. More...

static void	remove (const opflex::modb::URI &uri)
	Remove the RemoteIp 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 &invRemoteInventoryEpUuid, const std::string &invRemoteIpIp)
	Remove the RemoteIp object with the specified path elements from the managed object store. More...

static void	remove (const std::string &invRemoteInventoryEpUuid, const std::string &invRemoteIpIp)
	Remove the RemoteIp 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 = 127
	The unique class ID for RemoteIp.

Constructor & Destructor Documentation

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

inline

Construct an instance of RemoteIp.

This should not typically be called from user code.

Member Function Documentation

boost::optional<const std::string&> modelgbp::inv::RemoteIp::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().

const std::string& modelgbp::inv::RemoteIp::getIp ( const std::string & defaultValue )

inline

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

Parameters

defaultValue default value returned if the property is not set

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

References getIp().

bool modelgbp::inv::RemoteIp::isIpSet ( )

inline

Check whether ip has been set.

Returns: true if ip has been set

Referenced by getIp().

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

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

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

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

inlinestatic

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

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

inlinestatic

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

static void modelgbp::inv::RemoteIp::remove	(	opflex::ofcore::OFFramework &	framework,
		const std::string &	invRemoteInventoryEpUuid,
		const std::string &	invRemoteIpIp
	)

inlinestatic

Remove the RemoteIp 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/InvRemoteEndpointInventory/InvRemoteInventoryEp/[invRemoteInventoryEpUuid]/InvRemoteIp/[invRemoteIpIp]

Parameters

framework	the framework instance to use
invRemoteInventoryEpUuid	the value of invRemoteInventoryEpUuid, a naming property for RemoteInventoryEp
invRemoteIpIp	the value of invRemoteIpIp, a naming property for RemoteIp

Exceptions

std::logic_error if no mutator is active

References CLASS_ID.

static void modelgbp::inv::RemoteIp::remove	(	const std::string &	invRemoteInventoryEpUuid,
		const std::string &	invRemoteIpIp
	)

inlinestatic

Remove the RemoteIp 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/InvRemoteEndpointInventory/InvRemoteInventoryEp/[invRemoteInventoryEpUuid]/InvRemoteIp/[invRemoteIpIp]

Parameters

invRemoteInventoryEpUuid	the value of invRemoteInventoryEpUuid, a naming property for RemoteInventoryEp
invRemoteIpIp	the value of invRemoteIpIp, a naming property for RemoteIp

Exceptions

std::logic_error if no mutator is active

static boost::optional<OF_SHARED_PTR<modelgbp::inv::RemoteIp> > modelgbp::inv::RemoteIp::resolve	(	opflex::ofcore::OFFramework &	framework,
		const opflex::modb::URI &	uri
	)

inlinestatic

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

Referenced by resolve(), and modelgbp::inv::RemoteInventoryEp::resolveInvRemoteIp().

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

inlinestatic

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

static boost::optional<OF_SHARED_PTR<modelgbp::inv::RemoteIp> > modelgbp::inv::RemoteIp::resolve	(	opflex::ofcore::OFFramework &	framework,
		const std::string &	invRemoteInventoryEpUuid,
		const std::string &	invRemoteIpIp
	)

inlinestatic

Retrieve an instance of RemoteIp 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/InvRemoteEndpointInventory/InvRemoteInventoryEp/[invRemoteInventoryEpUuid]/InvRemoteIp/[invRemoteIpIp]

Parameters

framework	the framework instance to use
invRemoteInventoryEpUuid	the value of invRemoteInventoryEpUuid, a naming property for RemoteInventoryEp
invRemoteIpIp	the value of invRemoteIpIp, a naming property for RemoteIp

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::RemoteIp> > modelgbp::inv::RemoteIp::resolve	(	const std::string &	invRemoteInventoryEpUuid,
		const std::string &	invRemoteIpIp
	)

inlinestatic

Retrieve an instance of RemoteIp 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/InvRemoteEndpointInventory/InvRemoteInventoryEp/[invRemoteInventoryEpUuid]/InvRemoteIp/[invRemoteIpIp]

Parameters

invRemoteInventoryEpUuid	the value of invRemoteInventoryEpUuid, a naming property for RemoteInventoryEp
invRemoteIpIp	the value of invRemoteIpIp, a naming property for RemoteIp

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

References resolve().

modelgbp::inv::RemoteIp& modelgbp::inv::RemoteIp::setIp ( const std::string & newValue )

inline

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

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

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

modelgbp::inv::RemoteIp& modelgbp::inv::RemoteIp::unsetIp ( )

inline

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

RemoteIp.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

Member Function Documentation