CLAM::BaseNetwork Class Reference
#include <BaseNetwork.hxx>
Detailed Description
Definition at line 38 of file BaseNetwork.hxx.
Public Types | |
| typedef std::list< std::string > | NamesList |
| typedef std::map< std::string, Processing * > | ProcessingsMap |
| typedef std::list< InPortBase * > | InPortsList |
| typedef std::map< std::string, Geometry > | ProcessingsGeometriesMap |
| typedef std::list< Connection > | ConnectionsList |
Public Member Functions | |
| BaseNetwork () | |
| virtual | ~BaseNetwork () |
| virtual const char * | GetClassName () const =0 |
| Return the class name. | |
| virtual void | Clear ()=0 |
| virtual void | StoreOn (Storage &storage) const =0 |
| Stores component's subitems on the given Storage. | |
| virtual void | LoadFrom (Storage &storage)=0 |
| Loads component's subitems from the given Storage. | |
| virtual const std::string & | GetName () const =0 |
| virtual void | SetName (const std::string &name)=0 |
| virtual const std::string & | GetNetworkId (const Processing *proc) const =0 |
| virtual ProcessingsMap::iterator | BeginProcessings ()=0 |
| virtual ProcessingsMap::iterator | EndProcessings ()=0 |
| virtual ProcessingsMap::const_iterator | BeginProcessings () const =0 |
| virtual BaseNetwork::ProcessingsMap::const_iterator | EndProcessings () const =0 |
| virtual NamesList | GetInPortsConnectedTo (const std::string &producer) const =0 |
| virtual NamesList | GetInControlsConnectedTo (const std::string &producer) const =0 |
| virtual InPortsList | GetInPortsConnectedTo (OutPortBase &producer) const =0 |
| virtual std::string | GetConnectorIdentifier (const std::string &) const =0 |
| virtual std::string | GetProcessingIdentifier (const std::string &) const =0 |
| virtual InPortBase & | GetInPortByCompleteName (const std::string &name) const =0 |
| virtual OutPortBase & | GetOutPortByCompleteName (const std::string &name) const =0 |
| virtual InControl & | GetInControlByCompleteName (const std::string &name) const =0 |
| virtual OutControl & | GetOutControlByCompleteName (const std::string &name) const =0 |
| virtual bool | ConnectPorts (const std::string &, const std::string &)=0 |
| virtual bool | ConnectControls (const std::string &, const std::string &)=0 |
| virtual bool | DisconnectPorts (const std::string &, const std::string &)=0 |
| virtual bool | DisconnectControls (const std::string &, const std::string &)=0 |
| virtual std::string | GetUnconnectedInPorts () const =0 |
| Returns an string the full name of the unconnected inports. | |
| virtual bool | HasProcessing (const std::string &name) const =0 |
| methods used to create processings and get them | |
| virtual Processing & | GetProcessing (const std::string &name) const =0 |
| virtual void | AddProcessing (const std::string &, Processing *)=0 |
| add method using a pointer to a new processing | |
| virtual void | AddProcessing (const std::string &name, const std::string &key)=0 |
| add method using a key to get the new processing from factory | |
| virtual std::string | AddProcessing (const std::string &key)=0 |
| virtual std::string | GetUnusedName (const std::string &prefix) const =0 |
| virtual bool | RenameProcessing (const std::string &oldName, const std::string &newName)=0 |
| virtual void | RemoveProcessing (const std::string &)=0 |
| virtual bool | IsReady () const =0 |
| Tells whether the network is ready to rock. | |
| virtual bool | IsEmpty () const =0 |
| Returns true when it has no processings. | |
| virtual bool | HasMisconfiguredProcessings () const =0 |
| Returns true when some processing is misconfigured. | |
| virtual bool | HasUnconnectedInPorts () const =0 |
| Returns true when a processing has an inport that is not connected. | |
| virtual bool | HasSyncSource () const =0 |
| Tell whether the network contains any processing which limits the cpu usage such as file or device interfaces. | |
| virtual bool | ConfigureProcessing (const std::string &, const ProcessingConfig &)=0 |
| It configures the processing with the given processing id and config object and notifies this to the network. | |
| virtual void | ReconfigureAllProcessings ()=0 |
| Calls Configure() for each processing with its current configuration. | |
| virtual std::string | GetConfigurationErrors () const =0 |
| Returns an string containing configuration errors. | |
| virtual bool | UpdateSelections (const NamesList &processingsNamesList)=0 |
| virtual void | setPasteMode ()=0 |
| virtual bool | SetProcessingsGeometries (const ProcessingsGeometriesMap &processingsGeometries)=0 |
| virtual const ProcessingsGeometriesMap | GetAndClearGeometries ()=0 |
| virtual unsigned | BackendBufferSize ()=0 |
| virtual unsigned | BackendSampleRate ()=0 |
Protected Types | |
| typedef std::set< std::string > | NamesSet |
Protected Member Functions | |
| virtual bool | HasSelectionAndContains (const std::string &name) const =0 |
Static Protected Member Functions | |
| static std::size_t | PositionOfLastIdentifier (const std::string &str) |
| static std::size_t | PositionOfProcessingIdentifier (const std::string &str) |
| static char | NamesIdentifiersSeparator () |
Classes | |
| struct | Connection |
| struct | Geometry |
Member Typedef Documentation
| typedef std::list<std::string> CLAM::BaseNetwork::NamesList |
Definition at line 42 of file BaseNetwork.hxx.
| typedef std::map<std::string, Processing* > CLAM::BaseNetwork::ProcessingsMap |
Definition at line 43 of file BaseNetwork.hxx.
| typedef std::list<InPortBase *> CLAM::BaseNetwork::InPortsList |
Definition at line 44 of file BaseNetwork.hxx.
| typedef std::map<std::string, Geometry> CLAM::BaseNetwork::ProcessingsGeometriesMap |
Definition at line 47 of file BaseNetwork.hxx.
| typedef std::list<Connection> CLAM::BaseNetwork::ConnectionsList |
Definition at line 49 of file BaseNetwork.hxx.
typedef std::set<std::string> CLAM::BaseNetwork::NamesSet [protected] |
Definition at line 163 of file BaseNetwork.hxx.
Constructor & Destructor Documentation
| CLAM::BaseNetwork::BaseNetwork | ( | ) | [inline] |
Definition at line 52 of file BaseNetwork.hxx.
| virtual CLAM::BaseNetwork::~BaseNetwork | ( | ) | [inline, virtual] |
Definition at line 53 of file BaseNetwork.hxx.
Member Function Documentation
| virtual const char* CLAM::BaseNetwork::GetClassName | ( | ) | const [pure virtual] |
| virtual void CLAM::BaseNetwork::Clear | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::StoreOn | ( | Storage & | storage | ) | const [pure virtual] |
Stores component's subitems on the given Storage.
- Parameters:
-
storage The given storage where the subitem will be stored
- See also:
- Storage
Implements CLAM::Component.
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::LoadFrom | ( | Storage & | storage | ) | [pure virtual] |
Loads component's subitems from the given Storage.
- Parameters:
-
storage The given storage where the subitem will be loaded from
- See also:
- Storage
Implements CLAM::Component.
Implemented in CLAM::FlattenedNetwork.
| virtual const std::string& CLAM::BaseNetwork::GetName | ( | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::SetName | ( | const std::string & | name | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual const std::string& CLAM::BaseNetwork::GetNetworkId | ( | const Processing * | proc | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual ProcessingsMap::iterator CLAM::BaseNetwork::BeginProcessings | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual ProcessingsMap::iterator CLAM::BaseNetwork::EndProcessings | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual ProcessingsMap::const_iterator CLAM::BaseNetwork::BeginProcessings | ( | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual BaseNetwork::ProcessingsMap::const_iterator CLAM::BaseNetwork::EndProcessings | ( | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual NamesList CLAM::BaseNetwork::GetInPortsConnectedTo | ( | const std::string & | producer | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual NamesList CLAM::BaseNetwork::GetInControlsConnectedTo | ( | const std::string & | producer | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual InPortsList CLAM::BaseNetwork::GetInPortsConnectedTo | ( | OutPortBase & | producer | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::GetConnectorIdentifier | ( | const std::string & | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::GetProcessingIdentifier | ( | const std::string & | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual InPortBase& CLAM::BaseNetwork::GetInPortByCompleteName | ( | const std::string & | name | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual OutPortBase& CLAM::BaseNetwork::GetOutPortByCompleteName | ( | const std::string & | name | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual InControl& CLAM::BaseNetwork::GetInControlByCompleteName | ( | const std::string & | name | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual OutControl& CLAM::BaseNetwork::GetOutControlByCompleteName | ( | const std::string & | name | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::ConnectPorts | ( | const std::string & | , | |
| const std::string & | ||||
| ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::ConnectControls | ( | const std::string & | , | |
| const std::string & | ||||
| ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::DisconnectPorts | ( | const std::string & | , | |
| const std::string & | ||||
| ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::DisconnectControls | ( | const std::string & | , | |
| const std::string & | ||||
| ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::GetUnconnectedInPorts | ( | ) | const [pure virtual] |
Returns an string the full name of the unconnected inports.
Don't rely on the format because is subject to change.
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::HasProcessing | ( | const std::string & | name | ) | const [pure virtual] |
| virtual Processing& CLAM::BaseNetwork::GetProcessing | ( | const std::string & | name | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::AddProcessing | ( | const std::string & | , | |
| Processing * | ||||
| ) | [pure virtual] |
| virtual void CLAM::BaseNetwork::AddProcessing | ( | const std::string & | name, | |
| const std::string & | key | |||
| ) | [pure virtual] |
add method using a key to get the new processing from factory
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::AddProcessing | ( | const std::string & | key | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::GetUnusedName | ( | const std::string & | prefix | ) | const [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::RenameProcessing | ( | const std::string & | oldName, | |
| const std::string & | newName | |||
| ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::RemoveProcessing | ( | const std::string & | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::IsReady | ( | ) | const [pure virtual] |
Tells whether the network is ready to rock.
A network is ready when:
- it contains any processing,
- all processings are properly configured, and
- all in ports are connected,
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::IsEmpty | ( | ) | const [pure virtual] |
| virtual bool CLAM::BaseNetwork::HasMisconfiguredProcessings | ( | ) | const [pure virtual] |
| virtual bool CLAM::BaseNetwork::HasUnconnectedInPorts | ( | ) | const [pure virtual] |
Returns true when a processing has an inport that is not connected.
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::HasSyncSource | ( | ) | const [pure virtual] |
Tell whether the network contains any processing which limits the cpu usage such as file or device interfaces.
This is needed when executing a network in a real time process.
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::ConfigureProcessing | ( | const std::string & | , | |
| const ProcessingConfig & | ||||
| ) | [pure virtual] |
It configures the processing with the given processing id and config object and notifies this to the network.
So use this method instead of getting the processing with GetProcessing and calling Configure on it.
Implemented in CLAM::FlattenedNetwork.
| virtual void CLAM::BaseNetwork::ReconfigureAllProcessings | ( | ) | [pure virtual] |
Calls Configure() for each processing with its current configuration.
Implemented in CLAM::FlattenedNetwork.
| virtual std::string CLAM::BaseNetwork::GetConfigurationErrors | ( | ) | const [pure virtual] |
Returns an string containing configuration errors.
Don't rely on the format because is subject to change.
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::UpdateSelections | ( | const NamesList & | processingsNamesList | ) | [pure virtual] |
| virtual void CLAM::BaseNetwork::setPasteMode | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual bool CLAM::BaseNetwork::SetProcessingsGeometries | ( | const ProcessingsGeometriesMap & | processingsGeometries | ) | [pure virtual] |
| virtual const ProcessingsGeometriesMap CLAM::BaseNetwork::GetAndClearGeometries | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual unsigned CLAM::BaseNetwork::BackendBufferSize | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| virtual unsigned CLAM::BaseNetwork::BackendSampleRate | ( | ) | [pure virtual] |
Implemented in CLAM::FlattenedNetwork.
| static std::size_t CLAM::BaseNetwork::PositionOfLastIdentifier | ( | const std::string & | str | ) | [inline, static, protected] |
Definition at line 146 of file BaseNetwork.hxx.
References CLAM_ASSERT, and NamesIdentifiersSeparator().
Referenced by CLAM::FlattenedNetwork::GetConnectorIdentifier(), CLAM::FlattenedNetwork::GetProcessingIdentifier(), and PositionOfProcessingIdentifier().
| static std::size_t CLAM::BaseNetwork::PositionOfProcessingIdentifier | ( | const std::string & | str | ) | [inline, static, protected] |
Definition at line 152 of file BaseNetwork.hxx.
References NamesIdentifiersSeparator(), and PositionOfLastIdentifier().
Referenced by CLAM::FlattenedNetwork::GetProcessingIdentifier().
| static char CLAM::BaseNetwork::NamesIdentifiersSeparator | ( | ) | [inline, static, protected] |
Definition at line 158 of file BaseNetwork.hxx.
Referenced by PositionOfLastIdentifier(), and PositionOfProcessingIdentifier().
| virtual bool CLAM::BaseNetwork::HasSelectionAndContains | ( | const std::string & | name | ) | const [protected, pure virtual] |
The documentation for this class was generated from the following file:
