Contains FACE::Configuration documentation. More...

Data Structures
class	FACE::Configuration
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This is the interface class for the Configuration More...

struct	FACE::Configuration::WHENCE_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the parameter to FACE_Configuration_Seek. More...

Typedefs
typedef Long	FACE::Configuration::HANDLE_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the handle used during a session with a configuration container.

typedef STRING_TYPE	FACE::Configuration::INITIALIZATION_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to pass implementation specific initialization information to a Configuration API implementation.

typedef STRING_TYPE	FACE::Configuration::CONTAINER_NAME_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the name of a configuration container.

typedef STRING_TYPE	FACE::Configuration::SET_NAME_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the name of a configuration set within a configuration container.

typedef Long	FACE::Configuration::BUFFER_SIZE_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the length of the buffer or amount of data returned by FACE_Configuration_Read.

typedef Long	FACE::Configuration::OFFSET_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the desired offset used with FACE_Configuration_Seek.

Functions
virtual void	FACE::Configuration::Initialize (const INITIALIZATION_TYPE &initialization_information, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Initialize the Configuration instance

virtual void	FACE::Configuration::Open (const CONTAINER_NAME_TYPE &container_name, HANDLE_TYPE &handle, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Open method is used to establish a session with the Configuration implementation.

virtual void	FACE::Configuration::Get_Size (HANDLE_TYPE handle, const SET_NAME_TYPE &set_name, BUFFER_SIZE_TYPE &size, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Get_Size method is used to obtain the size of a particular configuration set from the configuration container associated with this session.

virtual void	FACE::Configuration::Read (HANDLE_TYPE handle, const SET_NAME_TYPE &set_name, SYSTEM_ADDRESS_TYPE buffer, BUFFER_SIZE_TYPE buffer_size, BUFFER_SIZE_TYPE &bytes_read, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Read method is used to obtain configuration information from the configuration container associated with this session.

virtual void	FACE::Configuration::Seek (HANDLE_TYPE handle, const WHENCE_TYPE::Value &whence, OFFSET_TYPE offset, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Seek method is used to set the current position indicator in the configuration session.

virtual void	FACE::Configuration::Close (HANDLE_TYPE handle, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Close method is used to conclude a sequence of operations on a configuration handle.

Detailed Description

Contains FACE::Configuration documentation.

FACE::Configuration is an interface that users can implement. rtiddsgen generated [DATATYPE_TYPE]_TSSConfigInterface.hpp that inherents this class.

Typedef Documentation

typedef Long FACE::Configuration::HANDLE_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the handle used during a session with a configuration container.

typedef STRING_TYPE FACE::Configuration::INITIALIZATION_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to pass implementation specific initialization information to a Configuration API implementation.

typedef STRING_TYPE FACE::Configuration::CONTAINER_NAME_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the name of a configuration container.

The contents of a configuration container are accessed during a session.

typedef STRING_TYPE FACE::Configuration::SET_NAME_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the name of a configuration set within a configuration container.

typedef Long FACE::Configuration::BUFFER_SIZE_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the length of the buffer or amount of data returned by FACE_Configuration_Read.

typedef Long FACE::Configuration::OFFSET_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the desired offset used with FACE_Configuration_Seek.

Function Documentation

virtual void FACE::Configuration::Initialize	(	const INITIALIZATION_TYPE &	initialization_information,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Initialize the Configuration instance

Parameters

[in]	initialization_information	provides implementation specific information which assists in the initialization of a Configuration API implementation.
[out]	return_code	contains a status code indicating success or failure.

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.

virtual void FACE::Configuration::Open	(	const CONTAINER_NAME_TYPE &	container_name,
		HANDLE_TYPE &	handle,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Open method is used to establish a session with the Configuration implementation.

Parameters

[in]	container_name	container_name is the name of the configuration container to open a session with.
[out]	handle	contains a handle to be used on subsequent calls during this session.
[out]	return_code	contains a status code indicating success or failure

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.; INVALID_CONFIG is returned in return_code to indicate that the configuration container specified is invalid.; INVALID_MODE is returned in return_code to indicate the caller does not have permission to access the configuration container.

virtual void FACE::Configuration::Get_Size	(	HANDLE_TYPE	handle,
		const SET_NAME_TYPE &	set_name,
		BUFFER_SIZE_TYPE &	size,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Get_Size method is used to obtain the size of a particular configuration set from the configuration container associated with this session.

Parameters

[in]	handle	indicates the current session.
[in]	set_name	indicates the name of the configuration set to obtain the value of.
[out]	return_code	contains a status code indicating success or failure
[out]	size	contains the size in bytes of the set.
[out]	return_code	contains a status code indicating success or failure.

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.; INVALID_CONFIG is returned in return_code to indicate that the handle is invalid.; NOT_AVAILABLE is returned in return_code to indicate that the size of the set is not available based on the backend media adapter used for this configuration information.

Note: For streaming configuration information sources, the set_name parameter should be set to "" or the empty string.

virtual void FACE::Configuration::Read	(	HANDLE_TYPE	handle,
		const SET_NAME_TYPE &	set_name,
		SYSTEM_ADDRESS_TYPE	buffer,
		BUFFER_SIZE_TYPE	buffer_size,
		BUFFER_SIZE_TYPE &	bytes_read,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Read method is used to obtain configuration information from the configuration container associated with this session.

Parameters

[in]	handle	indicates the current session.
[in]	set_name	indicates the name of the configuration set to obtain the value of.
[in]	buffer	points to the buffer to be filled in with configuration information.
[in]	buffer_size	indicates the size of the buffer and the maximum number of bytes which can be returned.
[out]	bytes_read	contains the number of bytes read on a successful read.
[out]	return_code	contains a status code indicating success or failure

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.; INVALID_CONFIG is returned in return_code to indicate that the handle is invalid.; NOT_AVAILABLE is returned in return_code to indicate that the entire data stream associated with this configuration set has been read.

Note: For streaming configuration information sources, the set_name parameter should be set to "all"

virtual void FACE::Configuration::Seek	(	HANDLE_TYPE	handle,
		const WHENCE_TYPE::Value &	whence,
		OFFSET_TYPE	offset,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Seek method is used to set the current position indicator in the configuration session.

Parameters

[in]	handle	indicates the current session.
[in]	whence	indicates how to interpret the offset parameter.
[in]	offset	indicates the desired offset.
[out]	return_code	contains a status code indicating success or failure

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.; INVALID_PARAM is returned in return_code to indicate that the whence parameter is invalid, or the offset is invalid for the specified value of whence.

Note: For some configuration media implementations, the Seek operation may not be applicable.

virtual void FACE::Configuration::Close	(	HANDLE_TYPE	handle,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Close method is used to conclude a sequence of operations on a configuration handle.

Parameters

[in]	handle	is the session to close
[out]	return_code	indicates success or failure

Returns: NO_ERROR is returned in return_code to indicate successful completion of the operation.; INVALID_CONFIG is returned in return_code to indicate that the handle is invalid.

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation