Brion  1.5.0
The Blue Brain C++ I/O library
brion::Target Class Reference

Read access to a Target file. More...

#include <target.h>

+ Inheritance diagram for brion::Target:
+ Collaboration diagram for brion::Target:

Public Member Functions

 ~Target ()
 Close target file. More...
 
Read API
 Target (const std::string &source)
 Open the given source to a target file for reading. More...
 
const Strings & getTargetNames (const TargetType type) const
 Get list of targets for the desired type. More...
 
const Strings & get (const std::string &name) const
 Get targets and/or GIDSet grouped by the given target. More...
 

Friends

std::ostream & operator<< (std::ostream &, const Target &)
 Stream out content of target file. More...
 

Detailed Description

Read access to a Target file.

Following RAII, this class is ready to use after the creation and will ensure release of resources upon destruction.

Definition at line 36 of file target.h.

Constructor & Destructor Documentation

brion::Target::~Target ( )

Close target file.

Version
1.0
brion::Target::Target ( const std::string &  source)
explicit

Open the given source to a target file for reading.

Parameters
sourcefilepath to target file
Exceptions
std::runtime_errorif file is not a valid target file
Version
1.0

Member Function Documentation

const Strings& brion::Target::get ( const std::string &  name) const

Get targets and/or GIDSet grouped by the given target.

Parameters
nametarget name to get the values from
Returns
list of values in the target. Can be targets and/or GIDSet
Version
1.0
const Strings& brion::Target::getTargetNames ( const TargetType  type) const

Get list of targets for the desired type.

Parameters
typedesired target type to look for
Returns
list of target names
Version
1.0

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ,
const Target  
)
friend

Stream out content of target file.


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