KIM::COLLECTION Namespace Reference

Contains the enumeration constants and the discovery routines for the Collection Extensible Enumeration. More...

Classes
struct	Comparator
	Structure provided for use with std::map. More...

Functions
void	GetNumberOfCollections (int *const numberOfCollections)
	Get the number of standard Collection's defined by the KIM API. More...
int	GetCollection (int const index, Collection *const collection)
	Get the identity of each defined standard Collection. More...

Variables
Collection const	system
	The standard system Collection. More...
Collection const	user
	The standard user Collection. More...
Collection const	environmentVariable
	The standard environmentVariable Collection. More...
Collection const	currentWorkingDirectory
	The standard currentWorkingDirectory Collection. More...

Detailed Description

Contains the enumeration constants and the discovery routines for the Collection Extensible Enumeration.

Function Documentation

GetCollection()

int KIM::COLLECTION::GetCollection	(	int const	index,
		Collection *const	collection
	)

Get the identity of each defined standard Collection.

Parameters

[in]	index	Zero-based index uniquely labeling each defined standard Collection. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]	collection	The Collection object associated with index.

Returns

true if index < 0 or index >= numberOfCollections.

false otherwise.

See also

KIM_COLLECTION_GetCollection, kim_collection_module::kim_get_collection

Since

2.1

GetNumberOfCollections()

void KIM::COLLECTION::GetNumberOfCollections

(

int *const

numberOfCollections

)

Get the number of standard Collection's defined by the KIM API.

Parameters

[out]

numberOfCollections

The number of standard Collection's defined by the KIM API.

See also

KIM_COLLECTION_GetNumberOfCollections, kim_collection_module::kim_get_number_of_collections

Since

2.1

Variable Documentation

currentWorkingDirectory

Collection const KIM::COLLECTION::currentWorkingDirectory

The standard currentWorkingDirectory Collection.

The current working directory collection.

See also

KIM_COLLECTION_currentWorkingDirectory, kim_collection_module::kim_collection_currentWorkingDirectory

Since

2.1

environmentVariable

Collection const KIM::COLLECTION::environmentVariable

The standard environmentVariable Collection.

The environment variable collection.

See also

KIM_COLLECTION_environmentVariable, kim_collection_module::kim_collection_environment_variable

Since

2.1

system

Collection const KIM::COLLECTION::system

The standard system Collection.

The system wide collection.

See also

KIM_COLLECTION_system, kim_collection_module::kim_collection_system

Since

2.1

user

Collection const KIM::COLLECTION::user

The standard user Collection.

The user collection.

See also

KIM_COLLECTION_user, kim_collection_module::kim_collection_user

Since

2.1