OSB_LIB::ResourceKey Struct Reference

Collaboration diagram for OSB_LIB::ResourceKey:

[legend]List of all members.

---

Detailed Description

Real-life unique identification of the resource.

The structure stores the data used to identify a resource without its (artificial) object id.

Definition at line 102 of file resourcefwd.h.

Public Member Functions

• ResourceKey ()

  Default constructor: sets type_ to rtUnknown.
  

• ResourceKey (ResourceType type, const ResourceNumber &number)

  Constructor with type and resource number.
  

• ResourceKey (ResourceType type, const ResourceNumber &number, const Id< Network > &nwId)

  Constructor with type, resource number and network id.
  

• ResourceKey (ResourceType type, const ResourceNumber &number, const Id2< NetworkElement > &neId)

  Constructor with type, resource number and network element id.
  

• bool operator< (const ResourceKey &rhs) const

  Less than operator.
  

• bool operator== (const ResourceKey &rhs) const

  Equality operator.
  

Public Attributes

• ResourceType type_

  The type of the resource.
  

• ResourceNumber number_

  The resource number.
  

• Id2< NetworkElement > neId_

  The network and network element of the resource.
  

---

Constructor & Destructor Documentation

OSB_LIB::ResourceKey::ResourceKey

(

)

Default constructor: sets type_ to rtUnknown.

OSB_LIB::ResourceKey::ResourceKey	(	ResourceType	type,
		const ResourceNumber &	number
	)

Constructor with type and resource number.

OSB_LIB::ResourceKey::ResourceKey	(	ResourceType	type,
		const ResourceNumber &	number,
		const Id< Network > &	nwId
	)

Constructor with type, resource number and network id.

OSB_LIB::ResourceKey::ResourceKey	(	ResourceType	type,
		const ResourceNumber &	number,
		const Id2< NetworkElement > &	neId
	)

Constructor with type, resource number and network element id.

---

Member Function Documentation

bool OSB_LIB::ResourceKey::operator<

(

const ResourceKey &

rhs

)

const [inline]

Less than operator.

Definition at line 172 of file resourcefwd.h.

References neId_, number_, and type_.

bool OSB_LIB::ResourceKey::operator==

(

const ResourceKey &

rhs

)

const [inline]

Equality operator.

Definition at line 179 of file resourcefwd.h.

References neId_, number_, and type_.

---

Member Data Documentation

Id2<NetworkElement> OSB_LIB::ResourceKey::neId_

The network and network element of the resource.

Note:

Both parts of neId_ may noy be set. It depends on the concrete resource type if they are mandatory, optional or not relevant.

Definition at line 114 of file resourcefwd.h.

Referenced by operator<(), and operator==().

ResourceNumber OSB_LIB::ResourceKey::number_

The resource number.

Definition at line 106 of file resourcefwd.h.

Referenced by operator<(), and operator==().

ResourceType OSB_LIB::ResourceKey::type_

The type of the resource.

Definition at line 104 of file resourcefwd.h.

Referenced by operator<(), and operator==().

---

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

• resourcefwd.h

---