ModelMetaData Class Reference

Public Member Functions
	ModelMetaData ()
	ModelMetaData (const Inputs &input)
const std::vector< PlaneMetaData > &	getPlanesContainer () const
const PlaneMetaData &	getPlaneMetaDataByIndex (int index) const
const std::vector< double > &	getToroidalAnglesMetaData ()

Detailed Description

class ModelMetaData holds the metadata information for all the poloidal planes.

Constructor & Destructor Documentation

ModelMetaData() [1/2]

ModelMetaData::ModelMetaData ( )

inline

Constructor to create an object of ModelMetaData.

ModelMetaData() [2/2]

ModelMetaData::ModelMetaData

(

const Inputs &

input

)

Constructor to create an object of ModelMetaData using input information.

Parameters

input

class holding all the input data.

Member Function Documentation

getPlaneMetaDataByIndex()

const PlaneMetaData & ModelMetaData::getPlaneMetaDataByIndex

(

int

index

)

const

Function to return the metadata on a individual plane by index.

Parameters

index

Takes the index value of the plane (0 to nPlanes-1) as input.

Returns

an object of PlaneMetaData.

getPlanesContainer()

const std::vector< PlaneMetaData > & ModelMetaData::getPlanesContainer

(

)

const

Function to return a vector containing all the planes with their meta data.

getToroidalAnglesMetaData()

const std::vector< double > & ModelMetaData::getToroidalAnglesMetaData

(

)

Function to get toroidal angles of all the planes. Returns a vector of the angles in radians.