modelgbp Generated OpFlex Model  1.3.0
modelgbp::gbpe::TunnelEp Class Reference
Inheritance diagram for modelgbp::gbpe::TunnelEp:

Public Member Functions

bool isEncapIdSet ()
 Check whether encapId has been set. More...
 
boost::optional< uint32_t > getEncapId ()
 Get the value of encapId if it has been set. More...
 
uint32_t getEncapId (uint32_t defaultValue)
 Get the value of encapId if set, otherwise the value of default passed in. More...
 
modelgbp::gbpe::TunnelEpsetEncapId (uint32_t newValue)
 Set encapId to the specified value in the currently-active mutator. More...
 
modelgbp::gbpe::TunnelEpunsetEncapId ()
 Unset encapId in the currently-active mutator. More...
 
bool isEncapTypeSet ()
 Check whether encapType has been set. More...
 
boost::optional< const uint8_t > getEncapType ()
 Get the value of encapType if it has been set. More...
 
const uint8_t getEncapType (const uint8_t defaultValue)
 Get the value of encapType if set, otherwise the value of default passed in. More...
 
modelgbp::gbpe::TunnelEpsetEncapType (const uint8_t newValue)
 Set encapType to the specified value in the currently-active mutator. More...
 
modelgbp::gbpe::TunnelEpunsetEncapType ()
 Unset encapType in the currently-active mutator. More...
 
bool isMacSet ()
 Check whether mac has been set. More...
 
boost::optional< const
opflex::modb::MAC & > 
getMac ()
 Get the value of mac if it has been set. More...
 
const opflex::modb::MAC & getMac (const opflex::modb::MAC &defaultValue)
 Get the value of mac if set, otherwise the value of default passed in. More...
 
modelgbp::gbpe::TunnelEpsetMac (const opflex::modb::MAC &newValue)
 Set mac to the specified value in the currently-active mutator. More...
 
modelgbp::gbpe::TunnelEpunsetMac ()
 Unset mac in the currently-active mutator. More...
 
bool isTerminatorIpSet ()
 Check whether terminatorIp has been set. More...
 
boost::optional< const
std::string & > 
getTerminatorIp ()
 Get the value of terminatorIp if it has been set. More...
 
const std::string & getTerminatorIp (const std::string &defaultValue)
 Get the value of terminatorIp if set, otherwise the value of default passed in. More...
 
modelgbp::gbpe::TunnelEpsetTerminatorIp (const std::string &newValue)
 Set terminatorIp to the specified value in the currently-active mutator. More...
 
modelgbp::gbpe::TunnelEpunsetTerminatorIp ()
 Unset terminatorIp in the currently-active mutator. More...
 
bool isUuidSet ()
 Check whether uuid has been set. More...
 
boost::optional< const
std::string & > 
getUuid ()
 Get the value of uuid if it has been set. More...
 
const std::string & getUuid (const std::string &defaultValue)
 Get the value of uuid if set, otherwise the value of default passed in. More...
 
modelgbp::gbpe::TunnelEpsetUuid (const std::string &newValue)
 Set uuid to the specified value in the currently-active mutator. More...
 
modelgbp::gbpe::TunnelEpunsetUuid ()
 Unset uuid in the currently-active mutator. More...
 
boost::optional
< boost::shared_ptr
< modelgbp::gbpe::Attestation > > 
resolveGbpeAttestation (const std::string &gbpeAttestationName)
 Retrieve the child object with the specified naming properties. More...
 
boost::shared_ptr
< modelgbp::gbpe::Attestation
addGbpeAttestation (const std::string &gbpeAttestationName)
 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 resolveGbpeAttestation (std::vector< boost::shared_ptr< modelgbp::gbpe::Attestation > > &out)
 Resolve and retrieve all of the immediate children of type modelgbp::gbpe::Attestation. More...
 
void remove ()
 Remove this instance using the currently-active mutator. More...
 
 TunnelEp (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri, const boost::shared_ptr< const opflex::modb::mointernal::ObjectInstance > &oi)
 Construct an instance of TunnelEp. More...
 

Static Public Member Functions

static boost::optional
< boost::shared_ptr
< modelgbp::gbpe::TunnelEp > > 
resolve (opflex::ofcore::OFFramework &framework, const opflex::modb::URI &uri)
 Retrieve an instance of TunnelEp from the managed object store. More...
 
static boost::optional
< boost::shared_ptr
< modelgbp::gbpe::TunnelEp > > 
resolve (const opflex::modb::URI &uri)
 Retrieve an instance of TunnelEp from the managed object store using the default framework instance. More...
 
static boost::optional
< boost::shared_ptr
< modelgbp::gbpe::TunnelEp > > 
resolve (opflex::ofcore::OFFramework &framework, const std::string &gbpeTunnelEpUuid)
 Retrieve an instance of TunnelEp from the managed object store by constructing its URI from the path elements that lead to it. More...
 
static boost::optional
< boost::shared_ptr
< modelgbp::gbpe::TunnelEp > > 
resolve (const std::string &gbpeTunnelEpUuid)
 Retrieve an instance of TunnelEp 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 TunnelEp object with the specified URI using the currently-active mutator. More...
 
static void remove (const opflex::modb::URI &uri)
 Remove the TunnelEp 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 &gbpeTunnelEpUuid)
 Remove the TunnelEp object with the specified path elements from the managed object store. More...
 
static void remove (const std::string &gbpeTunnelEpUuid)
 Remove the TunnelEp 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 = 34
 The unique class ID for TunnelEp.
 

Constructor & Destructor Documentation

modelgbp::gbpe::TunnelEp::TunnelEp ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri,
const boost::shared_ptr< const opflex::modb::mointernal::ObjectInstance > &  oi 
)
inline

Construct an instance of TunnelEp.

This should not typically be called from user code.

Member Function Documentation

boost::shared_ptr<modelgbp::gbpe::Attestation> modelgbp::gbpe::TunnelEp::addGbpeAttestation ( const std::string &  gbpeAttestationName)
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
gbpeAttestationNamethe value of gbpeAttestationName, a naming property for Attestation
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::gbpe::TunnelEp::getEncapId ( )
inline

Get the value of encapId if it has been set.

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

References isEncapIdSet().

Referenced by getEncapId().

uint32_t modelgbp::gbpe::TunnelEp::getEncapId ( uint32_t  defaultValue)
inline

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

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

References getEncapId().

boost::optional<const uint8_t> modelgbp::gbpe::TunnelEp::getEncapType ( )
inline

Get the value of encapType if it has been set.

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

References isEncapTypeSet().

Referenced by getEncapType().

const uint8_t modelgbp::gbpe::TunnelEp::getEncapType ( const uint8_t  defaultValue)
inline

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

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

References getEncapType().

boost::optional<const opflex::modb::MAC&> modelgbp::gbpe::TunnelEp::getMac ( )
inline

Get the value of mac if it has been set.

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

References isMacSet().

Referenced by getMac().

const opflex::modb::MAC& modelgbp::gbpe::TunnelEp::getMac ( const opflex::modb::MAC &  defaultValue)
inline

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

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

References getMac().

boost::optional<const std::string&> modelgbp::gbpe::TunnelEp::getTerminatorIp ( )
inline

Get the value of terminatorIp if it has been set.

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

References isTerminatorIpSet().

Referenced by getTerminatorIp().

const std::string& modelgbp::gbpe::TunnelEp::getTerminatorIp ( const std::string &  defaultValue)
inline

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

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

References getTerminatorIp().

boost::optional<const std::string&> modelgbp::gbpe::TunnelEp::getUuid ( )
inline

Get the value of uuid if it has been set.

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

References isUuidSet().

Referenced by getUuid().

const std::string& modelgbp::gbpe::TunnelEp::getUuid ( const std::string &  defaultValue)
inline

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

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

References getUuid().

bool modelgbp::gbpe::TunnelEp::isEncapIdSet ( )
inline

Check whether encapId has been set.

Returns
true if encapId has been set

Referenced by getEncapId().

bool modelgbp::gbpe::TunnelEp::isEncapTypeSet ( )
inline

Check whether encapType has been set.

Returns
true if encapType has been set

Referenced by getEncapType().

bool modelgbp::gbpe::TunnelEp::isMacSet ( )
inline

Check whether mac has been set.

Returns
true if mac has been set

Referenced by getMac().

bool modelgbp::gbpe::TunnelEp::isTerminatorIpSet ( )
inline

Check whether terminatorIp has been set.

Returns
true if terminatorIp has been set

Referenced by getTerminatorIp().

bool modelgbp::gbpe::TunnelEp::isUuidSet ( )
inline

Check whether uuid has been set.

Returns
true if uuid has been set

Referenced by getUuid().

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

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

Remove the TunnelEp 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::gbpe::TunnelEp::remove ( opflex::ofcore::OFFramework &  framework,
const std::string &  gbpeTunnelEpUuid 
)
inlinestatic

Remove the TunnelEp 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: /GbpeTunnelEpUniverse/GbpeTunnelEp/[gbpeTunnelEpUuid]

Parameters
frameworkthe framework instance to use
gbpeTunnelEpUuidthe value of gbpeTunnelEpUuid, a naming property for TunnelEp
Exceptions
std::logic_errorif no mutator is active

References CLASS_ID.

static void modelgbp::gbpe::TunnelEp::remove ( const std::string &  gbpeTunnelEpUuid)
inlinestatic

Remove the TunnelEp 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: /GbpeTunnelEpUniverse/GbpeTunnelEp/[gbpeTunnelEpUuid]

Parameters
gbpeTunnelEpUuidthe value of gbpeTunnelEpUuid, a naming property for TunnelEp
Exceptions
std::logic_errorif no mutator is active
static boost::optional<boost::shared_ptr<modelgbp::gbpe::TunnelEp> > modelgbp::gbpe::TunnelEp::resolve ( opflex::ofcore::OFFramework &  framework,
const opflex::modb::URI &  uri 
)
inlinestatic

Retrieve an instance of TunnelEp 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::gbpe::TunnelEpUniverse::resolveGbpeTunnelEp().

static boost::optional<boost::shared_ptr<modelgbp::gbpe::TunnelEp> > modelgbp::gbpe::TunnelEp::resolve ( const opflex::modb::URI &  uri)
inlinestatic

Retrieve an instance of TunnelEp 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<boost::shared_ptr<modelgbp::gbpe::TunnelEp> > modelgbp::gbpe::TunnelEp::resolve ( opflex::ofcore::OFFramework &  framework,
const std::string &  gbpeTunnelEpUuid 
)
inlinestatic

Retrieve an instance of TunnelEp 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: /GbpeTunnelEpUniverse/GbpeTunnelEp/[gbpeTunnelEpUuid]

Parameters
frameworkthe framework instance to use
gbpeTunnelEpUuidthe value of gbpeTunnelEpUuid, a naming property for TunnelEp
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

static boost::optional<boost::shared_ptr<modelgbp::gbpe::TunnelEp> > modelgbp::gbpe::TunnelEp::resolve ( const std::string &  gbpeTunnelEpUuid)
inlinestatic

Retrieve an instance of TunnelEp 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: /GbpeTunnelEpUniverse/GbpeTunnelEp/[gbpeTunnelEpUuid]

Parameters
gbpeTunnelEpUuidthe value of gbpeTunnelEpUuid, a naming property for TunnelEp
Returns
a shared pointer to the object or boost::none if it does not exist.

References resolve().

boost::optional<boost::shared_ptr<modelgbp::gbpe::Attestation> > modelgbp::gbpe::TunnelEp::resolveGbpeAttestation ( const std::string &  gbpeAttestationName)
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
gbpeAttestationNamethe value of gbpeAttestationName, a naming property for Attestation
Returns
a shared pointer to the object or boost::none if it does not exist.

References modelgbp::gbpe::Attestation::resolve().

void modelgbp::gbpe::TunnelEp::resolveGbpeAttestation ( std::vector< boost::shared_ptr< modelgbp::gbpe::Attestation > > &  out)
inline

Resolve and retrieve all of the immediate children of type modelgbp::gbpe::Attestation.

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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::setEncapId ( uint32_t  newValue)
inline

Set encapId 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::setEncapType ( const uint8_t  newValue)
inline

Set encapType 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::setMac ( const opflex::modb::MAC &  newValue)
inline

Set mac 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::setTerminatorIp ( const std::string &  newValue)
inline

Set terminatorIp 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::setUuid ( const std::string &  newValue)
inline

Set uuid 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::gbpe::TunnelEp::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::gbpe::TunnelEp::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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::unsetEncapId ( )
inline

Unset encapId 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::unsetEncapType ( )
inline

Unset encapType 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::unsetMac ( )
inline

Unset mac 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::unsetTerminatorIp ( )
inline

Unset terminatorIp 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::gbpe::TunnelEp& modelgbp::gbpe::TunnelEp::unsetUuid ( )
inline

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