FACE::Configuration Class Reference

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

#include <Configuration.hpp>

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

Public Types
typedef Long	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	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	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	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	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	OFFSET_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent the desired offset used with FACE_Configuration_Seek.

Public Member Functions
virtual void	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	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	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	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	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	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

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This is the interface class for the Configuration

This class is an interface that can be implemented by users for convenience. rtiddsgen also generated [DATATYPE_TYPE]_TSSConfigInterface.hpp that implemented this interface by default.