Timestep Class Reference

#include "Timestep.hpp"

Inheritance diagram for openstudio::model::Timestep:

Public Member Functions
int	numberOfTimestepsPerHour () const
bool	isNumberOfTimestepsPerHourDefaulted () const
bool	setNumberOfTimestepsPerHour (int numberOfTimestepsPerHour)
void	resetNumberOfTimestepsPerHour ()

Protected Member Functions
	Timestep (const Model &model)

Related Functions
typedef boost::optional< Timestep >	OptionalTimestep

Static Methods
static IddObjectType	iddObjectType ()
virtual	~Timestep ()

Detailed Description

Timestep derives from ModelObject and is an interface to the OpenStudio IDD object named "Timestep".

Timestep allows the user to set the zone timestep for EnergyPlus simulations. Timestep does not have a public constructor because it is a unique ModelObject. To get the Timestep object for a Model or create one if it does not yet exist use model.getUniqueObject<Timestep>(). To get the Timestep object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<Timestep>().

Constructor & Destructor Documentation

virtual openstudio::model::Timestep::~Timestep ( )

inlinevirtual

openstudio::model::Timestep::Timestep ( const Model &  model )

explicitprotected

Constructs a new Timestep object in the model.

Member Function Documentation

static IddObjectType openstudio::model::Timestep::iddObjectType ( )

static

bool openstudio::model::Timestep::isNumberOfTimestepsPerHourDefaulted

(

)

const

int openstudio::model::Timestep::numberOfTimestepsPerHour

(

)

const

void openstudio::model::Timestep::resetNumberOfTimestepsPerHour

(

)

bool openstudio::model::Timestep::setNumberOfTimestepsPerHour

(

int

numberOfTimestepsPerHour

)

Friends And Related Function Documentation

typedef boost::optional<Timestep> OptionalTimestep

related