Contains FACE::Configuration documentation.
More...
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
Function Documentation
<<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.
<<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.
<<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.
<<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"
<<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.
<<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.