OpenStudioCore:project
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Static Public Member Functions | Related Functions | List of all members
openstudio::project::MeasureRecord Class Reference

#include <MeasureRecord.hpp>

+ Inheritance diagram for openstudio::project::MeasureRecord:

Public Types

typedef MeasureRecordColumns ColumnsType
 
typedef detail::MeasureRecord_Impl ImplType
 
typedef MeasureRecord ObjectRecordType
 
- Public Types inherited from openstudio::project::ObjectRecord
typedef detail::ObjectRecord_Impl ImplType
 

Public Member Functions

Constructors and Destructors
virtual ~MeasureRecord ()
 
Getters
boost::optional< int > variableRecordId () const
 
boost::optional
< MeasureGroupRecord
measureGroupRecord () const
 Get the parent MeasureGroupRecord. More...
 
bool isSelected () const
 is this measure selected More...
 
bool setIsSelected (bool isSelected)
 set if this measure is selected More...
 
boost::optional< int > measureVectorIndex () const
 Index of this Measure in its (parent) MeasureGroup's vector of measures. More...
 
analysis::Measure measure () const
 
- Public Member Functions inherited from openstudio::project::ObjectRecord
std::string description () const
 get the description More...
 
std::string displayName () const
 get the display name More...
 
std::string name () const
 get the name More...
 
bool setDescription (const std::string &description)
 set the description More...
 
bool setDisplayName (const std::string &displayName)
 set the display name More...
 
bool setName (const std::string &name)
 set the name More...
 
DateTime timestampCreate () const
 get the timestamp the object was created at More...
 
DateTime timestampLast () const
 get the timestamp the object was last edited at More...
 
void updatePathData (const openstudio::path &originalBase, const openstudio::path &newBase)
 Update any path data stored under originalBase to newBase. More...
 
UUID uuidLast () const
 get the UUID of the object at last edit More...
 
virtual ~ObjectRecord ()
 
- Public Member Functions inherited from openstudio::project::Record
std::vector< ObjectRecordchildren () const
 Returns all child Records in the database. More...
 
bool connect (const std::string &signal, const QObject *qObject, const std::string &slot, Qt::ConnectionType type=Qt::AutoConnection) const
 Connect signal from this Records implementation object to slot on qObject. More...
 
std::string databaseTableName () const
 Returns the name of the database table. More...
 
std::vector< JoinRecordjoinRecords () const
 Returns all join Records in the database. More...
 
void moveToThread (QThread *targetThread)
 Move the implementation object to target thread. More...
 
ProjectDatabase projectDatabase () const
 Returns the ProjectDatabase, will throw if ProjectDatabase has been destructed. More...
 
std::vector< ObjectRecordresources () const
 Returns all resource Records in the database. More...
 
unsigned useCount () const
 Returns number of shared references to this Records implementation object. More...
 
int id () const
 Returns the id. More...
 
UUID handle () const
 Returns the handle. More...
 
template<typename T >
cast () const
 Cast to Record of type T, can throw std::bad_cast. More...
 
template<typename T >
boost::optional< T > optionalCast () const
 Cast to optional Record of type T. More...
 
virtual ~Record ()
 

Static Public Member Functions

static std::string databaseTableName ()
 get name of the database table More...
 
static MeasureRecord factoryFromMeasure (const analysis::Measure &measure, MeasureGroupRecord &measureGroupRecord, int measureVectorIndex)
 Create a MeasureRecord from measure that belongs to the discrete variable serialized to measureGroupRecord. More...
 
static boost::optional
< MeasureRecord
factoryFromQuery (const QSqlQuery &query, ProjectDatabase &database)
 get measure from query More...
 
static boost::optional
< MeasureRecord
getMeasureRecord (int id, ProjectDatabase &database)
 get measure by id More...
 
static std::vector< MeasureRecordgetMeasureRecords (ProjectDatabase &database)
 get all measures More...
 
static UpdateByIdQueryData updateByIdQueryData ()
 
static void updatePathData (ProjectDatabase database, const openstudio::path &originalBase, const openstudio::path &newBase)
 
- Static Public Member Functions inherited from openstudio::project::ObjectRecord
static void createIndices (QSqlDatabase &qSqlDatabase, const std::string &databaseTableName)
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< MeasureRecord
MeasureRecordVector
 
typedef boost::optional
< MeasureRecord
OptionalMeasureRecord
 

Additional Inherited Members

- Protected Member Functions inherited from openstudio::project::ObjectRecord
 ObjectRecord (std::shared_ptr< detail::ObjectRecord_Impl > impl, ProjectDatabase projectDatabase)
 constructor More...
 
 ObjectRecord (std::shared_ptr< detail::ObjectRecord_Impl > impl)
 constructor, does not register in database, use with caution More...
 
- Protected Member Functions inherited from openstudio::project::Record
void bindValues (QSqlQuery &query) const
 Bind values to a query for saving. More...
 
bool compareValues (const QSqlQuery &query) const
 Checks that values (except id) are same as query. More...
 
bool databaseCompare (const ProjectDatabase &projectDatabase) const
 Compares just this Record to the one in the database and check if they are exactly equal except for id, does not check children. More...
 
boost::optional< int > findIdByHandle () const
 Try to find this Record's id in the database by using its handle. More...
 
bool haveLastValues () const
 Checks if last values are set for this Record to revert back to. More...
 
void insertRow (ProjectDatabase &projectDatabase)
 Inserts a row in the database for this Record and sets id. More...
 
void insertRow (const std::shared_ptr< QSqlDatabase > &db)
 Inserts a row in the database for this Record and sets id. More...
 
void makeDeleteByHandleQuery (QSqlQuery &query) const
 Makes a query to delete Record with this handle from this Record's database table. More...
 
void makeDeleteByIdQuery (QSqlQuery &query) const
 Makes a query to delete Record with this id from this Record's database table. More...
 
void makeSelectAllQuery (QSqlQuery &query) const
 Makes a query to select all Records in this Record's database table. More...
 
void makeSelectByHandleQuery (QSqlQuery &query) const
 Makes a query to select Record with this handle in this Record's database table. More...
 
void makeSelectByIdQuery (QSqlQuery &query) const
 Makes a query to select Record with this id in this Record's database table. More...
 
void onChange ()
 Method called whenever the Record changes, emits onChange signal. More...
 
void removeRow (ProjectDatabase &projectDatabase)
 Removes just this Record from the database, does not remove children. More...
 
void removeRow (const std::shared_ptr< QSqlDatabase > &db)
 Removes just this Record from the database, does not remove children. More...
 
bool revertRow (ProjectDatabase &projectDatabase)
 Reverts just this Record then saves it in the database, does not revert children. More...
 
void revertToLastValues ()
 Revert values back to last state. More...
 
void saveLastValues ()
 Saves current values as last state. More...
 
void saveRow (ProjectDatabase &projectDatabase)
 Saves just this Record in the database, does not save children. More...
 
void saveRow (const std::shared_ptr< QSqlDatabase > &db)
 Saves just this Record in the database, does not save children. More...
 
void setLastValues (const QSqlQuery &query, ProjectDatabase &projectDatabase)
 Set the last state of this object from the query (including id). More...
 
void setLastValues (ProjectDatabase &projectDatabase)
 Sets the last state of just this Record from the database (including id), does not affect children. More...
 
 Record (std::shared_ptr< detail::Record_Impl > impl, ProjectDatabase projectDatabase)
 Constructs a new Record. More...
 
 Record (std::shared_ptr< detail::Record_Impl > impl)
 Constructs a new Record but does not create or save to a row in the database, use with caution. More...
 

Detailed Description

A Measure is an ObjectRecord that serializes a specific value of a MeasureGroup.

Member Typedef Documentation

typedef detail::MeasureRecord_Impl openstudio::project::MeasureRecord::ImplType

Constructor & Destructor Documentation

virtual openstudio::project::MeasureRecord::~MeasureRecord ( )
inlinevirtual

Member Function Documentation

static std::string openstudio::project::MeasureRecord::databaseTableName ( )
static

get name of the database table

static MeasureRecord openstudio::project::MeasureRecord::factoryFromMeasure ( const analysis::Measure &  measure,
MeasureGroupRecord measureGroupRecord,
int  measureVectorIndex 
)
static

Create a MeasureRecord from measure that belongs to the discrete variable serialized to measureGroupRecord.

The index is the vector index of measure in the variable.

static boost::optional<MeasureRecord> openstudio::project::MeasureRecord::factoryFromQuery ( const QSqlQuery &  query,
ProjectDatabase database 
)
static

get measure from query

static boost::optional<MeasureRecord> openstudio::project::MeasureRecord::getMeasureRecord ( int  id,
ProjectDatabase database 
)
static

get measure by id

static std::vector<MeasureRecord> openstudio::project::MeasureRecord::getMeasureRecords ( ProjectDatabase database)
static

get all measures

bool openstudio::project::MeasureRecord::isSelected ( ) const

is this measure selected

analysis::Measure openstudio::project::MeasureRecord::measure ( ) const
boost::optional<MeasureGroupRecord> openstudio::project::MeasureRecord::measureGroupRecord ( ) const

Get the parent MeasureGroupRecord.

boost::optional<int> openstudio::project::MeasureRecord::measureVectorIndex ( ) const

Index of this Measure in its (parent) MeasureGroup's vector of measures.

bool openstudio::project::MeasureRecord::setIsSelected ( bool  isSelected)

set if this measure is selected

static UpdateByIdQueryData openstudio::project::MeasureRecord::updateByIdQueryData ( )
static
static void openstudio::project::MeasureRecord::updatePathData ( ProjectDatabase  database,
const openstudio::path &  originalBase,
const openstudio::path &  newBase 
)
static
boost::optional<int> openstudio::project::MeasureRecord::variableRecordId ( ) const

Friends And Related Function Documentation

typedef std::vector<MeasureRecord> MeasureRecordVector
related
typedef boost::optional<MeasureRecord> OptionalMeasureRecord
related