PetaVision  Alpha
 All Data Structures Namespaces Functions Variables
PV::ParamGroupHandler Class Referenceabstract
Inheritance diagram for PV::ParamGroupHandler:
PV::CoreParamGroupHandler

Public Member Functions

virtual ColProbecreateColProbe (char const *keyword, char const *name, HyPerCol *hc)
 
virtual BaseConnectioncreateConnection (char const *keyword, char const *name, HyPerCol *hc, InitWeights *weightInitializer=NULL, NormalizeBase *weightNormalizer=NULL)
 
virtual HyPerColcreateHyPerCol (char const *keyword, char const *name, HyPerCol *hc)
 
virtual HyPerLayercreateLayer (char const *keyword, char const *name, HyPerCol *hc)
 
virtual BaseProbecreateProbe (char const *keyword, char const *name, HyPerCol *hc)
 
virtual InitWeightscreateWeightInitializer (char const *keyword, char const *name, HyPerCol *hc)
 
virtual NormalizeBasecreateWeightNormalizer (char const *keyword, char const *name, HyPerCol *hc)
 
virtual ParamGroupType getGroupType (char const *keyword)
 

Detailed Description

Definition at line 41 of file ParamGroupHandler.hpp.

Member Function Documentation

virtual ColProbe* PV::ParamGroupHandler::createColProbe ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a ColProbe keyword, create a ColProbe of the appropriate type, with the given name and parent HyPerCol. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 78 of file ParamGroupHandler.hpp.

virtual BaseConnection* PV::ParamGroupHandler::createConnection ( char const *  keyword,
char const *  name,
HyPerCol hc,
InitWeights weightInitializer = NULL,
NormalizeBase weightNormalizer = NULL 
)
inlinevirtual

If the keyword is recognized as a connection keyword, create a connection of the appropriate type, with the given name, parent HyPerCol, weight initializer, and weight normalizer. The weight initializer and weight normalizer arguments default to null. Null values should be allowed in these two arguments unless it is an error for the specified connection type to be instantiated with a null value. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 72 of file ParamGroupHandler.hpp.

virtual HyPerCol* PV::ParamGroupHandler::createHyPerCol ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a HyPerCol keyword, return the HyPerCol object; otherwise return NULL. Only the CoreParamGroupHandler should recognize a keyword returning HyPerColGroupType, and only the CoreParamGroupHandler should return a non-NULL value.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 57 of file ParamGroupHandler.hpp.

virtual HyPerLayer* PV::ParamGroupHandler::createLayer ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a layer keyword, create a layer of the appropriate type, with the given name and parent HyPerCol. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 63 of file ParamGroupHandler.hpp.

virtual BaseProbe* PV::ParamGroupHandler::createProbe ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a probe keyword, create a probe of the appropriate type, with the given name and parent HyPerCol. This method should handle both layer probes and connection probes. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 85 of file ParamGroupHandler.hpp.

virtual InitWeights* PV::ParamGroupHandler::createWeightInitializer ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a weight initialization keyword, create a weight initialization object of the appropriate type, with the given name and parent HyPerCol. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 92 of file ParamGroupHandler.hpp.

virtual NormalizeBase* PV::ParamGroupHandler::createWeightNormalizer ( char const *  keyword,
char const *  name,
HyPerCol hc 
)
inlinevirtual

If the keyword is recognized as a weight normalization keyword, create a weight normalization object of the appropriate type, with the given name and parent HyPerCol. If the keyword is not recognized, or is a non-layer keyword, the function should return NULL.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 99 of file ParamGroupHandler.hpp.

virtual ParamGroupType PV::ParamGroupHandler::getGroupType ( char const *  keyword)
inlinevirtual

Takes a keyword string as input, and returns whether the keyword is recognized as a layer keyword, a connection keyword, etc.

Reimplemented in PV::CoreParamGroupHandler.

Definition at line 50 of file ParamGroupHandler.hpp.


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