ldas-tools-framecpp  2.9.3
Public Types | Public Member Functions | Protected Attributes | List of all members
FrameCPP::v3::FrSH Class Reference

Storage space for FrSH information. More...

#include <FrSHData.hh>

Inheritance diagram for FrameCPP::v3::FrSH:
Inheritance graph
[legend]

Public Types

typedef std::string name_type
 
typedef std::string comment_type
 Comment.
 
typedef INT_2U class_type
 Class number of structure being described.
 
typedef std::string name_type
 
typedef std::string comment_type
 Comment.
 
typedef INT_2U class_type
 Class number of structure being described.
 
typedef std::string name_type
 
typedef std::string comment_type
 Comment.
 
typedef INT_2U class_type
 Class number of structure being described.
 

Public Member Functions

class_type GetClass () const
 Return class of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 
class_type GetClass () const
 Return class of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 
class_type GetClass () const
 Return class of object. More...
 
const comment_typeGetComment () const
 Return comment of object. More...
 
const name_typeGetName () const
 Return name of object. More...
 

Protected Attributes

name_type name
 
comment_type comment
 
class_type klass
 

Detailed Description

Storage space for FrSH information.

This stores information about an FrSH element that needs to persist beyond an I/O operation

Member Typedef Documentation

◆ name_type [1/3]

typedef std::string FrameCPP::v3::FrSH::name_type

Name of structure being described by this dictionary structure

◆ name_type [2/3]

typedef std::string FrameCPP::v3::FrSH::name_type

Name of structure being described by this dictionary structure

◆ name_type [3/3]

typedef std::string FrameCPP::v3::FrSH::name_type

Name of structure being described by this dictionary structure

Member Function Documentation

◆ GetClass() [1/3]

FrSH::class_type FrameCPP::v3::FrSH::GetClass ( ) const
inline

Return class of object.

Returns
Class number of structure being described

◆ GetClass() [2/3]

class_type FrameCPP::v3::FrSH::GetClass ( ) const

Return class of object.

Returns
Class number of structure being described

◆ GetClass() [3/3]

class_type FrameCPP::v3::FrSH::GetClass ( ) const

Return class of object.

Returns
Class number of structure being described

◆ GetComment() [1/3]

const FrSH::comment_type & FrameCPP::v3::FrSH::GetComment ( ) const
inline

Return comment of object.

Returns
Comment

◆ GetComment() [2/3]

const comment_type& FrameCPP::v3::FrSH::GetComment ( ) const

Return comment of object.

Returns
Comment

◆ GetComment() [3/3]

const comment_type& FrameCPP::v3::FrSH::GetComment ( ) const

Return comment of object.

Returns
Comment

◆ GetName() [1/3]

const FrSH::name_type & FrameCPP::v3::FrSH::GetName ( ) const
inline

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ GetName() [2/3]

const name_type& FrameCPP::v3::FrSH::GetName ( ) const

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ GetName() [3/3]

const name_type& FrameCPP::v3::FrSH::GetName ( ) const

Return name of object.

Returns
Name of structure being described by this dictionary structure

Member Data Documentation

◆ comment

comment_type FrameCPP::v3::FrSH::comment
protected

Comment

◆ klass

class_type FrameCPP::v3::FrSH::klass
protected

Class number of structure being described

◆ name

name_type FrameCPP::v3::FrSH::name
protected

Name of structure being described by this dictionary structure


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