FrameCPP::v3::FrSH Class Reference

Storage space for FrSH information. More...

#include <FrSHData.hh>

Inheritance diagram for FrameCPP::v3::FrSH:

Collaboration diagram for FrameCPP::v3::FrSH:

Public Types
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.
const comment_type &	GetComment () const
	Return comment of object.
const name_type &	GetName () const
	Return name of object.
class_type	GetClass () const
	Return class of object.
const comment_type &	GetComment () const
	Return comment of object.
const name_type &	GetName () const
	Return name of object.

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

class_type

typedef INT_2U FrameCPP::v3::FrSH::class_type

Class number of structure being described.

comment_type

typedef std::string FrameCPP::v3::FrSH::comment_type

Comment.

name_type

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

Name of structure being described by this dictionary structure

Member Function Documentation

GetClass() [1/2]

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

inline

Return class of object.

Returns

Class number of structure being described

GetClass() [2/2]

class_type FrameCPP::v3::FrSH::GetClass

(

)

const

Return class of object.

Returns

Class number of structure being described

GetComment() [1/2]

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

inline

Return comment of object.

Returns

Comment

GetComment() [2/2]

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

(

)

const

Return comment of object.

Returns

Comment

GetName() [1/2]

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/2]

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 files:

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4/build/include/framecpp/storage/data/v3/FrSHData.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4/src/storage/data/v3/FrSHData.hh