Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members

SDIFEntity - Description type


Functions

bool Easdif::SDIFEntity::AddFrameType (const std::string &frametype, const std::string &matrix)
 add new frame type or change existing frame type of the entity
bool Easdif::SDIFEntity::AddMatrixType (const std::string &matrixtype, const std::string &colnames)
 define a new or redefine an existing matrix type for the entity.
int Easdif::SDIFEntity::PrintTypes ()
const std::string & Easdif::SDIFEntity::GetTypeString () const
bool Easdif::SDIFEntity::SetTypeString (const std::string &TypeString)

Function Documentation

bool Easdif::SDIFEntity::AddFrameType const std::string &  frametype,
const std::string &  matrix
[inherited]
 

add new frame type or change existing frame type of the entity

the description is added to the file with WriteTypes() when the entity is opened for wrinting.Therefore, type descriptors have to be added to the entity before the file is opened.

AddFrameType() must be used after Easdif::SDIFEntity::AddMatrixType()

Parameters:
frametype string that identifies the new frame type, the identifier will use at most 4 characters
matrix string that defines the matrix elements that may be part of the frame
Example:

entity.AddFrameType("1NEW", "1NEW NewMatrix; 1FQ0 New1FQ0");

bool Easdif::SDIFEntity::AddMatrixType const std::string &  matrixtype,
const std::string &  colnames
[inherited]
 

define a new or redefine an existing matrix type for the entity.

The type description is added to the entity when the entity is opened for writing. Therefore, type descriptors have to be added to the entity before the file is opened.

AddMatrixType() must be used before Easdif::SDIFEntity::AddFrameType()

Parameters:
matrixtype string for define a new matrix type or redefined a matrix type
colnames string to defined the differents parameters of the matrix type
Example:

entity.AddMatrixType("1NEW", "amplitude, phase");

int Easdif::SDIFEntity::PrintTypes  )  [inherited]
 

Print the SdifStringT* which have the types definitions of the frames and matrix

const std::string & Easdif::SDIFEntity::GetTypeString  )  const [inherited]
 

return a string containing the user defined types of the file that is stored in the frame "1TYP".

Returns:
Type string

bool Easdif::SDIFEntity::SetTypeString const std::string &  TypeString  )  [inherited]
 

Set the user defined frame types in the frame "1TYP" for the current file to the argument string

Parameters:
TypeString 
Returns:
true if success


Generated on Tue Jan 3 15:00:56 2006 for Easdif by  doxygen 1.3.9.1