PetaVision  Alpha
PV::BaseLayer Class Reference

#include <BaseLayer.hpp>

Inheritance diagram for PV::BaseLayer:
PV::BaseObject PV::CheckpointerDataInterface PV::Observer PV::HyPerLayer PV::ANNLayer PV::BinningLayer PV::CloneVLayer PV::ConstantLayer PV::FilenameParsingGroundTruthLayer PV::InputLayer PV::KmeansLayer PV::LIF PV::PoolingIndexLayer PV::Retina PV::Segmentify PV::SegmentLayer PV::WTALayer

Public Member Functions

bool getDataStructuresAllocatedFlag ()
std::string const & getDescription () const
char const * getDescription_c () const
bool getInitialValuesSetFlag ()
bool getInitInfoCommunicatedFlag ()
char const * getKeyword () const
MPIBlock const * getMPIBlock ()
char const * getName () const
bool isUsingGPU () const
virtual int registerData (Checkpointer *checkpointer)
virtual int respond (std::shared_ptr< BaseMessage const > message) override

Protected Member Functions

virtual int allocateDataStructures ()
virtual int cleanup ()
virtual int communicateInitInfo (CommunicateInitInfoMessage const *message)
virtual int copyInitialStateToGPU ()
int initialize (char const *name, HyPerCol *hc)
virtual int initializeState ()
virtual int prepareCheckpointWrite ()
virtual int processCheckpointRead ()
virtual int readStateFromCheckpoint (Checkpointer *checkpointer) override
int respondAllocateData (AllocateDataMessage const *message)
int respondCleanup (CleanupMessage const *message)
int respondCommunicateInitInfo (CommunicateInitInfoMessage const *message)
int respondCopyInitialStateToGPUMessage (CopyInitialStateToGPUMessage const *message)
int respondInitializeState (InitializeStateMessage const *message)
int respondPrepareCheckpointWrite (PrepareCheckpointWriteMessage const *message)
int respondProcessCheckpointRead (ProcessCheckpointReadMessage const *message)
int respondReadStateFromCheckpoint (ReadStateFromCheckpointMessage< Checkpointer > const *message)
int respondRegisterData (RegisterDataMessage< Checkpointer > const *message)
void setDataStructuresAllocatedFlag ()
virtual int setDescription ()
void setInitialValuesSetFlag ()
void setInitInfoCommunicatedFlag ()
int setName (char const *name)
int setParent (HyPerCol *hc)

Protected Attributes

std::string description
bool mDataStructuresAllocatedFlag = false
bool mInitialValuesSetFlag = false
bool mInitInfoCommunicatedFlag = false
bool mUsingGPUFlag = false
char * name = nullptr
HyPerColparent = nullptr

Detailed Description

The base class for layers. BaseLayer should not be instantiated itself; instead, instantiate classes derived from BaseLayer.

BaseLayer should not be templated; if the occasion arises to template classes, this should be done at the HyPerLayer level or below. The rationale is that HyPerCol stores an array of layers, and needs a class that all layers, however templated, are derived from.

Definition at line 23 of file BaseLayer.hpp.

Member Function Documentation

bool PV::BaseObject::getDataStructuresAllocatedFlag ( )

Get-method for mDataStructuresAllocatedFlag, which is false on initialization and then becomes true once setDataStructuresAllocatedFlag() is called.

Definition at line 65 of file BaseObject.hpp.

bool PV::BaseObject::getInitialValuesSetFlag ( )

Get-method for mInitialValuesSetFlag, which is false on initialization and then becomes true once setInitialValuesSetFlag() is called.

Definition at line 71 of file BaseObject.hpp.

bool PV::BaseObject::getInitInfoCommunicatedFlag ( )

Get-method for mInitInfoCommunicatedFlag, which is false on initialization and then becomes true once setInitInfoCommunicatedFlag() is called.

Definition at line 58 of file BaseObject.hpp.

bool PV::BaseObject::isUsingGPU ( ) const

Returns true if the object requires the GPU; false otherwise. HyPerCol will not initialize the GPU unless one of the objects in its hierarchy returns true

Definition at line 79 of file BaseObject.hpp.

void PV::BaseObject::setDataStructuresAllocatedFlag ( )

This method sets mDataStructuresAllocatedFlag to true.

Definition at line 111 of file BaseObject.hpp.

void PV::BaseObject::setInitialValuesSetFlag ( )

This method sets the flag returned by getInitialValuesSetFlag to true.

Definition at line 116 of file BaseObject.hpp.

void PV::BaseObject::setInitInfoCommunicatedFlag ( )

This method sets mInitInfoCommunicatedFlag to true.

Definition at line 106 of file BaseObject.hpp.

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