ldas-tools-framecpp  2.7.0
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
Description Class Reference
Collaboration diagram for Description:
Collaboration graph
[legend]

Classes

struct  info
 

Public Types

typedef std::list< infoses_type
 
typedef std::vector< void *> struct_data_type
 

Public Member Functions

void AddSE (const std::string &Name, const std::string &Class, const std::string &Comment)
 
std::string Class (INT_4U Index) const
 
void ClassName (const std::string &ClassName)
 
const std::string & ClassName () const
 
void Dump (const struct_data_type &Data, const CommandLine &Options) const
 write out description More...
 
void DumpCommonElements (const struct_data_type &Data, const std::string &ClassName) const
 write out description More...
 
bool Read (FrameStream &FStream, struct_data_type &Data) const
 Read data from the stream using the given description. More...
 
template<typename T >
Value (const struct_data_type &Data, INT_2U Offset) const
 

Private Member Functions

void * read (FrameStream &FStream, const std::string &Class)
 

Private Attributes

std::string m_class_name
 
ses_type m_se
 

Member Typedef Documentation

◆ ses_type

typedef std::list< info > Description::ses_type

◆ struct_data_type

typedef std::vector< void* > Description::struct_data_type

Member Function Documentation

◆ AddSE()

void Description::AddSE ( const std::string &  Name,
const std::string &  Class,
const std::string &  Comment 
)

Add an FrSE element to the definition

Parameters
NameName of an element of the structure being described.
ClassContains the string representation of the data type
CommentDescription of the element and its purpose.

◆ Class()

std::string Description::Class ( INT_4U  Index) const
inline

◆ ClassName() [1/2]

void Description::ClassName ( const std::string &  ClassName)
inline

◆ ClassName() [2/2]

const std::string& Description::ClassName ( ) const
inline

◆ Dump()

void Description::Dump ( const struct_data_type Data,
const CommandLine Options 
) const

write out description

Todo:
Need to add option to limit the number of data points to print.

◆ DumpCommonElements()

void Description::DumpCommonElements ( const struct_data_type Data,
const std::string &  ClassName 
) const

write out description

◆ Read()

bool Description::Read ( FrameStream FStream,
struct_data_type Data 
) const

Read data from the stream using the given description.

◆ read()

void* Description::read ( FrameStream FStream,
const std::string &  Class 
)
private

◆ Value()

template<typename T >
T Description::Value ( const struct_data_type Data,
INT_2U  Offset 
) const

Member Data Documentation

◆ m_class_name

std::string Description::m_class_name
private

◆ m_se

ses_type Description::m_se
private

The documentation for this class was generated from the following file: