SwitchNetBodyC - Model switch controller body.

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

SwitchBodyC

Variables:

Methods:

SwitchNetBodyC(const StringC & addr): Make a connection.
SwitchNetBodyC(): Default constructor.
BooleanT Connect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Disconnect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Issue(const SalvoC & salvo): issue a salvo.
Make connections specified in salvo, if possible.
BooleanT Expire(const SalvoC & salvo): Expire a salvo.
This tells the system the salvo is no longer needed.
BooleanT Break(const SalvoC & salvo): Break a salvo.
This tells the system to kill an existing salvo.

#include "amma/Studio/Switch.hh"

StringC SwitchID(const StringC & matrixId): Get identifier for the switch.
StringC SwitchMedia(const StringC & matrixId): Get media type for switch.
e.g. Video-SDI,Video-Component,Audio-Analog ....
DListC<StringC> ListResources(const StringC & matrixId,SwitchResourceT rtype): List sources available.
DListC<ConnectionC> ListConnections(const StringC & matrixId): List sources available.
BooleanT Connect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Disconnect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Connect(const DListC<ConnectionC> & cons): Make a set of connections.
If any of the connections aren't possible, the whole command fails and no changes are made.
BooleanT IsConnected(const StringC & matrixId,const StringC & src,const StringC & dest): Test if connection is present.
---------- Salvo -----------
BooleanT Issue(const SalvoC & salvo): issue a salvo.
Make connections specified in salvo, if possible.
BooleanT Expire(const SalvoC & salvo): Expire a salvo.
This tells the system the salvo is no longer needed.
BooleanT Break(const SalvoC & salvo): Break a salvo.
This tells the system to kill an existing salvo.
BooleanT CheckIssue(const SalvoC & salvo): Check all the connections in a salvo have been made.
BooleanT CheckPossible(const SalvoC & salvo): Check if its possible to issue a salvo at the moment.
BooleanT CheckPossible(const ConnectionC & salvo): Check if its possible to make a connection at the moment.
BooleanT CheckConnection(const ConnectionC & salvo): Check if connection is forced by one or more salvo's.
DListC<SalvoC> ActiveSalvos(): List active salvo's.
Signal2C<SalvoC,SalvoStateT> & SigSalvo(): Access salvo changed signal.
void SetSwitch(SwitchDriverC & sm): Setup switch model.
SalvoC FindSalvo(const StringC & nm,const StringC & nuser = StringC()): Search for a named salvo in the active list.

#include "amma/Studio/SwitchDriver.hh"

BooleanT Save(BinOStreamC & os) const: Save model to a stream.
StringC SwitchID(const StringC & matrixId): Get identifier for the switch.
StringC SwitchMedia(const StringC & matrixId): Get media type for switch.
e.g. Video-SDI,Video-Component,Audio-Analog ....
DListC<StringC> ListResources(const StringC & matrixId,SwitchResourceT rtype): List sources available.
DListC<ConnectionC> ListConnections(const StringC & matrixId): List sources available.
BooleanT Connect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Disconnect(const StringC & matrixId,const StringC & src,const StringC & dest,const StringC & attr = StringC("")): Connect source to destination.
BooleanT Disconnect(const ConnectionC & con): Connect source to destination.
BooleanT Connect(const DListC<ConnectionC> & cons): Make a set of connections.
If any of the connections aren't possible, the whole command fails and no changes are made.
BooleanT IsConnected(const StringC & matrixId,const StringC & src,const StringC & dest): Test if connection is present.
BooleanT IsConnected(const ConnectionC & con): Test if connection is present.
Signal1C<ConnectionC> & SigConnect(): Connection changed signal.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

SwitchNetBodyC

Model switch controller body.

include	"amma/Studio/SwitchNet.hh"
User Level:	Default
Library:	Studio
Example:	SockServer.cc
Section:	default.Charles Galambos
In Scope:	StudioN