Inheritance diagram for PV::ConnectionData:

ConnectionData Parameters
List of parameters needed from the ConnectionData class
virtual void	ioParam_preLayerName (enum ParamsIOFlag ioFlag)
	preLayerName: Specifies the connection's pre layer More...

virtual void	ioParam_postLayerName (enum ParamsIOFlag ioFlag)
	preLayerName: Specifies the connection's post layer More...

Public Member Functions
	ConnectionData (char const name, HyPerCol hc)

bool	getDataStructuresAllocatedFlag () const

std::string const &	getDescription () const

char const *	getDescription_c () const

bool	getInitialValuesSetFlag () const

bool	getInitInfoCommunicatedFlag () const

MPIBlock const *	getMPIBlock ()

char const *	getName () const

std::string const &	getObjectType () const

HyPerLayer *	getPost ()

char const *	getPostLayerName () const

HyPerLayer *	getPre ()

char const *	getPreLayerName () const

void	ioParams (enum ParamsIOFlag ioFlag, bool printHeader, bool printFooter)

bool	isUsingGPU () const

char const *	lookupKeyword () const

void	readParams ()

virtual Response::Status	registerData (Checkpointer *checkpointer)

virtual Response::Status	respond (std::shared_ptr< BaseMessage const > message) override

void	writeParams ()

Protected Member Functions
virtual Response::Status	allocateDataStructures ()

virtual Response::Status	cleanup ()

virtual Response::Status	communicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message) override

virtual Response::Status	copyInitialStateToGPU ()

int	initialize (char const name, HyPerCol hc)

virtual Response::Status	initializeState ()

virtual int	ioParamsFillGroup (enum ParamsIOFlag ioFlag) override

virtual Response::Status	prepareCheckpointWrite ()

virtual Response::Status	processCheckpointRead ()

virtual Response::Status	readStateFromCheckpoint (Checkpointer *checkpointer) override

Response::Status	respondAllocateData (std::shared_ptr< AllocateDataMessage const > message)

Response::Status	respondCleanup (std::shared_ptr< CleanupMessage const > message)

Response::Status	respondCommunicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message)

Response::Status	respondCopyInitialStateToGPU (std::shared_ptr< CopyInitialStateToGPUMessage const > message)

Response::Status	respondInitializeState (std::shared_ptr< InitializeStateMessage const > message)

Response::Status	respondPrepareCheckpointWrite (std::shared_ptr< PrepareCheckpointWriteMessage const > message)

Response::Status	respondProcessCheckpointRead (std::shared_ptr< ProcessCheckpointReadMessage const > message)

Response::Status	respondReadStateFromCheckpoint (std::shared_ptr< ReadStateFromCheckpointMessage< Checkpointer > const > message)

Response::Status	respondRegisterData (std::shared_ptr< RegisterDataMessage< Checkpointer > const > message)

Response::Status	respondSetCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)

virtual Response::Status	setCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)

void	setDataStructuresAllocatedFlag ()

void	setDescription ()

void	setInitialValuesSetFlag ()

void	setInitInfoCommunicatedFlag ()

int	setName (char const *name)

virtual void	setObjectType () override

int	setParent (HyPerCol *hc)

Static Protected Member Functions
static void	inferPreAndPostFromConnName (const char *name, int rank, std::string &preLayerNameString, std::string &postLayerNameString)

Protected Attributes
std::string	description

PVCuda::CudaDevice *	mCudaDevice = nullptr

bool	mDataStructuresAllocatedFlag = false

bool	mInitialValuesSetFlag = false

bool	mInitInfoCommunicatedFlag = false

std::string	mObjectType

HyPerLayer *	mPost = nullptr

char *	mPostLayerName = nullptr

HyPerLayer *	mPre = nullptr

char *	mPreLayerName = nullptr

bool	mUsingGPUFlag = false

char *	name = nullptr

HyPerCol *	parent = nullptr

Detailed Description

Definition at line 16 of file ConnectionData.hpp.

Member Function Documentation

bool PV::BaseObject::getDataStructuresAllocatedFlag ( ) const

inlineinherited

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

Definition at line 102 of file BaseObject.hpp.

bool PV::BaseObject::getInitialValuesSetFlag ( ) const

inlineinherited

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

Definition at line 108 of file BaseObject.hpp.

bool PV::BaseObject::getInitInfoCommunicatedFlag ( ) const

inlineinherited

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

Definition at line 95 of file BaseObject.hpp.

HyPerLayer* PV::ConnectionData::getPost ( )

inline

Returns a pointer to the connection's postsynaptic layer.

Definition at line 59 of file ConnectionData.hpp.

char const* PV::ConnectionData::getPostLayerName ( ) const

inline

Returns the name of the connection's postsynaptic layer.

Definition at line 49 of file ConnectionData.hpp.

HyPerLayer* PV::ConnectionData::getPre ( )

inline

Returns a pointer to the connection's presynaptic layer.

Definition at line 54 of file ConnectionData.hpp.

char const* PV::ConnectionData::getPreLayerName ( ) const

inline

Returns the name of the connection's presynaptic layer.

Definition at line 44 of file ConnectionData.hpp.

void PV::ConnectionData::inferPreAndPostFromConnName	(	const char *	name,
		int	rank,
		std::string &	preLayerNameString,
		std::string &	postLayerNameString
	)

staticprotected

If the character string given by name has the form "AbcToXyz", then preLayerNameString is set to Abc and postLayerNameString is set to Xyz. If the given character string does not contain "To" or if it contains "To" in more than one place, an error message is printed and the preLayerNameString and postLayerNameString are set to the empty string.

Definition at line 105 of file ConnectionData.cpp.

void PV::ConnectionData::ioParam_postLayerName ( enum ParamsIOFlag ioFlag )

protectedvirtual

preLayerName: Specifies the connection's post layer

Required parameter

Reimplemented in PV::FeedbackConnectionData.

Definition at line 41 of file ConnectionData.cpp.

void PV::ConnectionData::ioParam_preLayerName ( enum ParamsIOFlag ioFlag )

protectedvirtual

preLayerName: Specifies the connection's pre layer

Required parameter

Reimplemented in PV::FeedbackConnectionData.

Definition at line 36 of file ConnectionData.cpp.

void PV::BaseObject::ioParams	(	enum ParamsIOFlag	ioFlag,
		bool	printHeader,
		bool	printFooter
	)

inherited

Method for reading or writing the params from group in the parent HyPerCol's parameters. The group from params is selected using the name of the connection.

If ioFlag is set to write, the printHeader and printFooter flags control whether a header and footer for the parameter group is produces. These flags are set to true for layers, connections, and probes; and set to false for weight initializers and normalizers. If ioFlag is set to read, the printHeader and printFooter flags are ignored.

Note that ioParams is not virtual. To add parameters in a derived class, override ioParamFillGroup.

Definition at line 74 of file BaseObject.cpp.

int PV::ConnectionData::ioParamsFillGroup ( enum ParamsIOFlag ioFlag )

overrideprotectedvirtual

The virtual method for reading parameters from the parent HyPerCol's parameters, and writing to the output params file.

Derived classes with additional parameters typically override ioParamsFillGroup to call the base class's ioParamsFillGroup method and then call ioParam_[parametername] for each of their parameters. The ioParam_[parametername] methods should call the parent HyPerCol's ioParamValue() and related methods, to ensure that all parameters that get read also get written to the outputParams-generated file.

Reimplemented from PV::BaseObject.

Reimplemented in PV::FeedbackConnectionData.

Definition at line 30 of file ConnectionData.cpp.

bool PV::BaseObject::isUsingGPU ( ) const

inlineinherited

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 116 of file BaseObject.hpp.

char const * PV::BaseObject::lookupKeyword ( ) const

inherited

Look up the keyword of the params group with the same name as the object.

Definition at line 42 of file BaseObject.cpp.

void PV::BaseObject::readParams ( )

inlineinherited

A method that reads the parameters for the group whose name matches the name of the object. It, along with writeParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 62 of file BaseObject.hpp.

void PV::BaseObject::setDataStructuresAllocatedFlag ( )

inlineprotectedinherited

This method sets mDataStructuresAllocatedFlag to true.

Definition at line 175 of file BaseObject.hpp.

void PV::BaseObject::setInitialValuesSetFlag ( )

inlineprotectedinherited

This method sets the flag returned by getInitialValuesSetFlag to true.

Definition at line 180 of file BaseObject.hpp.

void PV::BaseObject::setInitInfoCommunicatedFlag ( )

inlineprotectedinherited

This method sets mInitInfoCommunicatedFlag to true.

Definition at line 170 of file BaseObject.hpp.

void PV::BaseObject::writeParams ( )

inlineinherited

A method that writes the parameters for the group whose name matches the name of the object. It, along with readParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 69 of file BaseObject.hpp.

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

OpenPV/src/components/ConnectionData.hpp
OpenPV/src/components/ConnectionData.cpp

ConnectionData Parameters

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation