Summary_Frame Class Reference

Summary of Frame. More...

#include <TimeSlice.hh>

Inheritance diagram for Summary_Frame:

Public Types
typedef void	item_type
	item type definition

Public Member Functions
const unsigned short	lcm_id () const
	get LCM idendifier
const unsigned char	ars_id () const
	get ARS idendifier
const unsigned char	data_type () const
	get data type
const unsigned short	numberOfItems () const
	get number of items
	Summary_Frame ()
	Default constructor.
virtual	~Summary_Frame ()
	Virtual destructor.
const bool	operator== (const Summary_Frame &object)
	equal operator.
const bool	operator!= (const Summary_Frame &object) const
	not-equal operator.
const bool	operator< (const Summary_Frame &object) const
	less than operator.
Summary_Frame &	operator+= (const Summary_Frame &object)
	operator +=
	ClassDef (Summary_Frame, 2)
	ROOT class definition.
const unsigned short	lcm_id () const
	get LCM idendifier
const unsigned char	ars_id () const
	get ARS idendifier
const unsigned char	data_type () const
	get data type
const unsigned short	numberOfItems () const
	get number of items
	Summary_Frame ()
	Default constructor.
virtual	~Summary_Frame ()
	Virtual destructor.
const bool	operator== (const Summary_Frame &object)
	equal operator.
const bool	operator!= (const Summary_Frame &object) const
	not-equal operator.
const bool	operator< (const Summary_Frame &object) const
	less than operator.
Summary_Frame &	operator+= (const Summary_Frame &object)
	operator +=
	ClassDef (Summary_Frame, 2)
	ROOT class definition.

Protected Attributes
unsigned short	lcm_id_
	LCM identifier.
unsigned char	ars_id_
	ARS identifier.
unsigned char	data_type_
	data type
unsigned short	numberOfItems_
	number of items

Friends
std::ostream &	operator<< (std::ostream &out, const Summary_Frame &object)
	Print ASCII.
std::ostream &	operator<< (std::ostream &out, const Summary_Frame &object)
	Print ASCII.

Detailed Description

Summary of Frame.

Definition at line 21 of file build/antares-dataformat/TimeSlice.hh.

Member Typedef Documentation

item_type

typedef void Summary_Frame::item_type

item type definition

Definition at line 36 of file build/antares-dataformat/TimeSlice.hh.

Constructor & Destructor Documentation

Summary_Frame() [1/2]

Summary_Frame::Summary_Frame ( )

inline

Default constructor.

Definition at line 65 of file build/antares-dataformat/TimeSlice.hh.

                  :
    lcm_id_(0),
    ars_id_(0),
    data_type_(0),
    numberOfItems_(0)
  {}

~Summary_Frame() [1/2]

virtual Summary_Frame::~Summary_Frame ( )

inlinevirtual

Virtual destructor.

Definition at line 75 of file build/antares-dataformat/TimeSlice.hh.

{}

Summary_Frame() [2/2]

Summary_Frame::Summary_Frame ( )

inline

Default constructor.

Definition at line 65 of file TimeSlice.hh.

                  :
    lcm_id_(0),
    ars_id_(0),
    data_type_(0),
    numberOfItems_(0)
  {}

~Summary_Frame() [2/2]

virtual Summary_Frame::~Summary_Frame ( )

inlinevirtual

Virtual destructor.

Definition at line 75 of file TimeSlice.hh.

{}

Member Function Documentation

lcm_id() [1/2]

const unsigned short Summary_Frame::lcm_id ( ) const

inline

get LCM idendifier

Returns

LCM identifier

Definition at line 42 of file build/antares-dataformat/TimeSlice.hh.

{ return lcm_id_; }

ars_id() [1/2]

const unsigned char Summary_Frame::ars_id ( ) const

inline

get ARS idendifier

Returns

ARS identifier

Definition at line 48 of file build/antares-dataformat/TimeSlice.hh.

{ return ars_id_; }

data_type() [1/2]

const unsigned char Summary_Frame::data_type ( ) const

inline

get data type

Returns

data type

Definition at line 54 of file build/antares-dataformat/TimeSlice.hh.

{ return data_type_; }

numberOfItems() [1/2]

const unsigned short Summary_Frame::numberOfItems ( ) const

inline

get number of items

Returns

number of items

Definition at line 60 of file build/antares-dataformat/TimeSlice.hh.

{ return numberOfItems_; }

operator==() [1/2]

const bool Summary_Frame::operator== ( const Summary_Frame & object )

inline

equal operator.

Parameters

object

summary frame

Returns

true if equals object; else false

Definition at line 83 of file build/antares-dataformat/TimeSlice.hh.

  {
    return (lcm_id_    == object.lcm_id_   &&
            ars_id_    == object.ars_id_   &&
            data_type_ == object.data_type_);
  }

operator!=() [1/2]

const bool Summary_Frame::operator!= ( const Summary_Frame & object ) const

inline

not-equal operator.

Parameters

object

summary frame

Returns

true if not equals object; else false

Definition at line 96 of file build/antares-dataformat/TimeSlice.hh.

  {
    return (lcm_id_    != object.lcm_id_   ||
            ars_id_    != object.ars_id_   ||
            data_type_ != object.data_type_);
  }

operator<() [1/2]

const bool Summary_Frame::operator< ( const Summary_Frame & object ) const

inline

less than operator.

Parameters

object

summary frame

Returns

true if less than object; else false

Definition at line 109 of file build/antares-dataformat/TimeSlice.hh.

  {
    if (lcm_id_ == object.lcm_id_)
      if (ars_id_ == object.ars_id_)
        return data_type_ < object.data_type_;
      else
        return ars_id_ < object.ars_id_;
    else
      return lcm_id_ < object.lcm_id_;
  }

operator+=() [1/2]

Summary_Frame & Summary_Frame::operator+= ( const Summary_Frame & object )

inline

operator +=

Parameters

object

summar frame

Returns

this summay frame

Definition at line 143 of file build/antares-dataformat/TimeSlice.hh.

  {
    if (*this == object) {
      numberOfItems_ += object.numberOfItems_;
    }
    
    return *this;
  }

ClassDef() [1/2]

Summary_Frame::ClassDef	(	Summary_Frame	,
		2	)

ROOT class definition.

lcm_id() [2/2]

const unsigned short Summary_Frame::lcm_id ( ) const

inline

get LCM idendifier

Returns

LCM identifier

Definition at line 42 of file TimeSlice.hh.

{ return lcm_id_; }

ars_id() [2/2]

const unsigned char Summary_Frame::ars_id ( ) const

inline

get ARS idendifier

Returns

ARS identifier

Definition at line 48 of file TimeSlice.hh.

{ return ars_id_; }

data_type() [2/2]

const unsigned char Summary_Frame::data_type ( ) const

inline

get data type

Returns

data type

Definition at line 54 of file TimeSlice.hh.

{ return data_type_; }

numberOfItems() [2/2]

const unsigned short Summary_Frame::numberOfItems ( ) const

inline

get number of items

Returns

number of items

Definition at line 60 of file TimeSlice.hh.

{ return numberOfItems_; }

operator==() [2/2]

const bool Summary_Frame::operator== ( const Summary_Frame & object )

inline

equal operator.

Parameters

object

summary frame

Returns

true if equals object; else false

Definition at line 83 of file TimeSlice.hh.

  {
    return (lcm_id_    == object.lcm_id_   &&
            ars_id_    == object.ars_id_   &&
            data_type_ == object.data_type_);
  }

operator!=() [2/2]

const bool Summary_Frame::operator!= ( const Summary_Frame & object ) const

inline

not-equal operator.

Parameters

object

summary frame

Returns

true if not equals object; else false

Definition at line 96 of file TimeSlice.hh.

  {
    return (lcm_id_    != object.lcm_id_   ||
            ars_id_    != object.ars_id_   ||
            data_type_ != object.data_type_);
  }

operator<() [2/2]

const bool Summary_Frame::operator< ( const Summary_Frame & object ) const

inline

less than operator.

Parameters

object

summary frame

Returns

true if less than object; else false

Definition at line 109 of file TimeSlice.hh.

  {
    if (lcm_id_ == object.lcm_id_)
      if (ars_id_ == object.ars_id_)
        return data_type_ < object.data_type_;
      else
        return ars_id_ < object.ars_id_;
    else
      return lcm_id_ < object.lcm_id_;
  }

operator+=() [2/2]

Summary_Frame & Summary_Frame::operator+= ( const Summary_Frame & object )

inline

operator +=

Parameters

object

summar frame

Returns

this summay frame

Definition at line 143 of file TimeSlice.hh.

  {
    if (*this == object) {
      numberOfItems_ += object.numberOfItems_;
    }
    
    return *this;
  }

ClassDef() [2/2]

Summary_Frame::ClassDef	(	Summary_Frame	,
		2	)

ROOT class definition.

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const Summary_Frame & object )

friend

Print ASCII.

Parameters

out	output stream
object	Summary frame

Returns

output stream

Definition at line 127 of file build/antares-dataformat/TimeSlice.hh.

  {
    using namespace std;
    
    return out << setw(5) << (int) object.lcm_id_        << ' ' 
               << setw(2) << (int) object.ars_id_        << ' ' 
               << setw(2) << (int) object.data_type_     << ' ' 
               << setw(5) << (int) object.numberOfItems_ << endl;
  }

operator<< [2/2]

std::ostream & operator<< ( std::ostream & out, const Summary_Frame & object )

friend

Print ASCII.

Parameters

out	output stream
object	Summary frame

Returns

output stream

Definition at line 127 of file TimeSlice.hh.

  {
    using namespace std;
    
    return out << setw(5) << (int) object.lcm_id_        << ' ' 
               << setw(2) << (int) object.ars_id_        << ' ' 
               << setw(2) << (int) object.data_type_     << ' ' 
               << setw(5) << (int) object.numberOfItems_ << endl;
  }

Member Data Documentation

lcm_id_

unsigned short Summary_Frame::lcm_id_

protected

LCM identifier.

Definition at line 24 of file build/antares-dataformat/TimeSlice.hh.

ars_id_

unsigned char Summary_Frame::ars_id_

protected

ARS identifier.

Definition at line 26 of file build/antares-dataformat/TimeSlice.hh.

data_type_

unsigned char Summary_Frame::data_type_

protected

data type

Definition at line 28 of file build/antares-dataformat/TimeSlice.hh.

numberOfItems_

unsigned short Summary_Frame::numberOfItems_

protected

number of items

Definition at line 30 of file build/antares-dataformat/TimeSlice.hh.

---

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

• build/antares-dataformat/TimeSlice.hh
• TimeSlice.hh