ROAst
 All Classes Functions Variables Enumerations
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ROAst::Box Class Reference
Inheritance diagram for ROAst::Box:
Inheritance graph
[legend]
Collaboration diagram for ROAst::Box:
Collaboration graph
[legend]

Public Member Functions

 Box (EqAstCoord regvertex, double regheight, double regwidth)
 
virtual ~Box ()
 
virtual void WriteRegion (std::string const &file) const
 
EqAstCoord GetVertex () const
 
double GetRegHeight () const
 
double GetRegWidth () const
 
virtual std::string GetRegionShape () const
 
void SetRegVertex (EqAstCoord regvertex)
 
void SetRegHeight (double regheight)
 
void SetRegWidth (double regwidth)
 
virtual std::vector< AstroObjectGetInObjects (AstroObject const &filter) const
 
virtual bool ExecuteEvent (AstroObject const &ConditionObject) const
 
virtual void PopulateRegion ()
 
virtual void Clear ()
 
- Public Member Functions inherited from ROAst::Region
 Region (EqAstCoord centre)
 
virtual ~Region ()
 
EqAstCoord GetRegCentre () const
 
void SetRegCentre (EqAstCoord centre)
 
virtual void WriteRegion (std::string const &file)=0
 

Public Attributes

std::vector< AstroObjectBoxContainer
 

Protected Attributes

EqAstCoord RegVertex
 
double RegHeight
 
double RegWidth
 
std::string RegionShape
 
- Protected Attributes inherited from ROAst::Region
EqAstCoord Centre
 

Constructor & Destructor Documentation

ROAst::Box::Box ( EqAstCoord  regvertex,
double  regheight,
double  regwidth 
)

A container with the astronomical object of the box

virtual ROAst::Box::~Box ( )
virtual

Creates an box region of Height "regheight" and width "regwidth" and vertex "regvertex"

Member Function Documentation

virtual void ROAst::Box::Clear ( )
virtual

local mathod to project the objects on the region populating its container.

Implements ROAst::Region.

virtual bool ROAst::Box::ExecuteEvent ( AstroObject const &  ConditionObject) const
virtual

Local member to extract the all the astronomical objects specified by filter present in the selected region

Implements ROAst::Region.

virtual std::vector<AstroObject> ROAst::Box::GetInObjects ( AstroObject const &  filter) const
virtual

Changes RegWidth

Implements ROAst::Region.

double ROAst::Box::GetRegHeight ( ) const

Retruns RegVertex

virtual std::string ROAst::Box::GetRegionShape ( ) const
virtual

Retruns RegWidth

Implements ROAst::Region.

double ROAst::Box::GetRegWidth ( ) const

Retruns RegHeight

EqAstCoord ROAst::Box::GetVertex ( ) const

Local method to write in a file the selected region

virtual void ROAst::Box::PopulateRegion ( )
virtual

Local method to return true if the ConditionObject is found in the region

Implements ROAst::Region.

void ROAst::Box::SetRegHeight ( double  regheight)

Changes RegVertex

void ROAst::Box::SetRegVertex ( EqAstCoord  regvertex)

Local method to return the region shape

void ROAst::Box::SetRegWidth ( double  regwidth)

Changes RegHeight

virtual void ROAst::Box::WriteRegion ( std::string const &  file) const
virtual

Destructor

Member Data Documentation

std::vector<AstroObject> ROAst::Box::BoxContainer

The shape of the region

double ROAst::Box::RegHeight
protected

One vertex of the box region

std::string ROAst::Box::RegionShape
protected

Width of the box region

double ROAst::Box::RegWidth
protected

Height of the box region


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