Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

base::VFile Class Reference

Inheritance diagram for base::VFile:

Inheritance graph
[legend]
Collaboration diagram for base::VFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~VFile ()
virtual bool isDirectory () const
virtual String extension () const=0
 the file's extension (e.g. 'png')

virtual std::istream & istream () const=0 throw (io_error)
virtual std::ostream & ostream () const=0 throw (io_error)
virtual std::iostream & iostream (std::iostream::openmode mode=(std::iostream::in|std::iostream::out)) const=0 throw (io_error)
virtual void close () const=0 throw (io_error)
 close the file (can be re-opened again via istream/ostream/iostream() )

virtual bool operator== (const VEntry &e) const
virtual const PathName path () const
virtual const PathName name () const
virtual const PathName pathName () const
virtual bool isSameKindAs (const ReferencedObject &) const
virtual bool isSameKindAs (const Object &) const
virtual String className () const=0
void reference () const
bool unreference () const
const int referenceCount () const
void enableOnUnreferenceCall (bool enabled)
virtual void onUnreference () const

Protected Member Functions

 VFile (const PathName &pathname)
 VFile (const VFile &f)

Protected Attributes

PathName pathname
int _refCount
bool onUnreferenceEnabled

Friends

class VFileSystem
class VDirectory
class VFile

Constructor & Destructor Documentation

virtual base::VFile::~VFile (   )  [inline, virtual]
 

Definition at line 43 of file VFile.

base::VFile::VFile (  const PathName &  pathname  )  [inline, protected]
 

Definition at line 56 of file VFile.

base::VFile::VFile (  const VFile &  f  )  [inline, protected]
 

Definition at line 57 of file VFile.

References f.

Member Function Documentation

virtual String base::Object::className (   )  const [pure virtual, inherited]
 

return the name of the object's class type. Must be defined by derived classes.

Implemented in base::Application, base::BinarySerializer, base::Cache, base::CacheDirectory, base::CacheFile, base::ConstantExpression, base::CosExpression, base::DifferenceExpression, base::Directory, base::Expression, base::Externalizer, base::File, base::LineSegPathRep, base::LineSegTrajectoryRep, base::Math, base::NegateExpression, base::ParametricPathRep, base::ParametricTrajectoryRep, base::Path, base::PathComponent, base::PathName, base::ProductExpression, base::QuotientExpression, base::SimpleXMLSerializer, base::SinExpression, base::StdFileSystem, base::SumExpression, base::Time, base::Trajectory, base::Universe, base::VariableExpression, base::VDirectory, base::WaypointPathRep, base::WaypointTrajectoryRep, base::World, gfx::IndexedPoint3Array, gfx::OSGWorld, gfx::TriangleIterator, gfx::VisualPath, gfx::VisualTriangles, gfx::VisualTriangles::TriangleArrayIteratorState, physics::Body, physics::Box, physics::Capsule, physics::CollidableGroup, physics::CollisionModel::ModelState, physics::CollisionState, physics::Cone, physics::Cylinder, physics::DynamicSpatial, physics::GJKCollisionDetector, physics::GJKCollisionDetector::GJKCollisionState, physics::GJKCollisionModel, physics::HeightField, physics::LODTerrain, physics::MassProperties, physics::Material, physics::NullCollisionResponseHandler, physics::OBBCollisionDetector, physics::OBBCollisionDetector::OBBCollisionState, physics::OBBCollisionModel, physics::ODEBallJoint, physics::ODECollidableBody, physics::ODECollidableBody::BodyState, physics::ODECollidableGroup, physics::ODECollisionCuller, physics::ODECollisionDetector, physics::ODECollisionDetector::ODECollisionState, physics::ODECollisionModel, physics::ODECollisionResponseHandler, physics::ODEConstraintGroup, physics::ODEContactConstraint, physics::ODEDoubleHingeJoint, physics::ODEFixedConstraint, physics::ODEHingeJoint, physics::ODEMotor, physics::ODESliderJoint, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::ODESolidSystem, physics::ODEUniversalJoint, physics::Polyhedron, physics::Polyhedron::Vertex, physics::Polyhedron::Edge, physics::Polyhedron::Polygon, physics::SimpleCollisionCuller, physics::SimpleTerrain, physics::Solid, physics::SOLIDCollisionDetector, physics::SOLIDCollisionDetector::SOLIDCollisionState, physics::SOLIDCollisionModel, physics::SolidCollisionResponseHandler, physics::SpatialGroup, physics::SpatialTransform, physics::Sphere, physics::Torus, physics::VisualDebugUtil, robot::AggregateControlInterface, robot::control::ControllableAdaptor, robot::control::ControllableAdaptor::AdaptorControlInterface, robot::control::kinematics::AnalyticLagrangianFSBetaOptimizer, robot::control::kinematics::AnalyticLagrangianNullSpaceBetaOptimizer, robot::control::kinematics::BetaFormConstraints::BetaFormConstraint, robot::control::kinematics::BetaFormConstraints, robot::control::kinematics::IKOR, robot::control::kinematics::IKOR::JointLimitBetaConstraint, robot::control::kinematics::IKOR::PushAwayBetaConstraint, robot::control::kinematics::IKOR::RankLossBetaConstraint, robot::control::kinematics::IKORController, robot::control::kinematics::IKORController::EEPositionControlInterface, robot::control::kinematics::IKORController::LinkPositionsControlInterface, robot::control::kinematics::IKORFullSpaceSolver, robot::control::kinematics::LeastNormIKSolver, robot::control::kinematics::MPPseudoInvSolver, robot::control::kinematics::OldIKOR, robot::control::kinematics::ReferenceOpVectorFormObjective, robot::control::kinematics::SVDFullSpaceSolver, robot::control::ManipulatorPIDPositionController, robot::control::ManipulatorPIDPositionController::PositionInterface, robot::JFKengine, robot::KinematicChain::Link, robot::KinematicChain, robot::ManipulatorDescription, robot::ManipulatorJointTrajectory, robot::NumericKinematicEvaluator, robot::PlatformDescription, robot::RobotDescription, robot::sim::BasicEnvironment, robot::sim::BasicEnvironment::Tool, robot::sim::BasicEnvironment::Obstacle, robot::sim::Environment, robot::sim::IKORTest, robot::sim::IKORTest::Test, robot::sim::IKORTester, robot::sim::SimulatedBasicEnvironment, robot::sim::SimulatedKinematicChain::ProximityCollisionResponseHandler, robot::sim::SimulatedManipulatorDescription, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedRobot::ManipulatorControlInterface, robot::sim::SimulatedRobot::ToolControlInterface, robot::sim::SimulatedRobot::PlatformControlInterface, robot::sim::SimulatedRobot::ProximitySensorInterface, robot::sim::SimulatedRobotDescription, robot::sim::SimulatedSerialManipulator, robot::sim::SimulatedTool, robot::sim::TestBasicEnvironment, robot::sim::VisualIKORTest, robot::TestRobot, robot::TestRobot::ManipulatorControlInterface, robot::TestRobot::ToolControlInterface, robot::TestRobot::PlatformControlInterface, robot::TestRobot::ProximitySensorInterface, and robot::ToolDescription.

virtual void base::VFile::close (   )  const throw (io_error) [pure virtual]
 

close the file (can be re-opened again via istream/ostream/iostream() )

Implemented in base::CacheFile, and base::File.

void base::Referenced::enableOnUnreferenceCall (  bool  enabled  )  [inline, inherited]
 

If enabled, each call to unreference() will also call virtual method onUnreference()

Definition at line 115 of file Referenced.

References base::Referenced::onUnreferenceEnabled.

virtual String base::VFile::extension (   )  const [pure virtual]
 

the file's extension (e.g. 'png')

Implemented in base::CacheFile, and base::File.

virtual std::iostream& base::VFile::iostream (  std::iostream::openmode  mode = (std::iostream::in|std::iostream::out)  )  const throw (io_error) [pure virtual]
 

Implemented in base::CacheFile, and base::File.

virtual bool base::VFile::isDirectory (   )  const [inline, virtual]
 

Implements base::VEntry.

Definition at line 45 of file VFile.

virtual bool base::Object::isSameKindAs (  const Object &   )  const [inline, virtual, inherited]
 

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs (  const ReferencedObject &   )  const [inline, virtual, inherited]
 

Definition at line 52 of file ReferencedObject.

virtual std::istream& base::VFile::istream (   )  const throw (io_error) [pure virtual]
 

Implemented in base::CacheFile, and base::File.

virtual const PathName base::VEntry::name (   )  const [inline, virtual, inherited]
 

Definition at line 45 of file VEntry.

References base::PathName::name(), and base::VEntry::pathname.

virtual void base::Referenced::onUnreference (   )  const [inline, virtual, inherited]
 

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references

Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor.

Definition at line 121 of file Referenced.

Referenced by base::Referenced::unreference().

virtual bool base::VEntry::operator== (  const VEntry &  e  )  const [inline, virtual, inherited]
 

Definition at line 41 of file VEntry.

References base::VEntry::pathname.

virtual std::ostream& base::VFile::ostream (   )  const throw (io_error) [pure virtual]
 

Implemented in base::CacheFile, and base::File.

virtual const PathName base::VEntry::path (   )  const [inline, virtual, inherited]
 

Reimplemented in base::CacheFile.

Definition at line 44 of file VEntry.

References base::PathName::path(), and base::VEntry::pathname.

virtual const PathName base::VEntry::pathName (   )  const [inline, virtual, inherited]
 

Reimplemented in base::CacheFile.

Definition at line 46 of file VEntry.

References base::VEntry::pathname.

void base::Referenced::reference (   )  const [inline, inherited]
 

Increment the reference count by one, indicating that this object has another pointer which is referencing it.

Definition at line 65 of file Referenced.

References base::Referenced::_refCount.

const int base::Referenced::referenceCount (   )  const [inline, inherited]
 

Return the number pointers currently referencing this object.

Definition at line 112 of file Referenced.

References base::Referenced::_refCount.

Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

bool base::Referenced::unreference (   )  const [inline, inherited]
 

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted.

Definition at line 81 of file Referenced.

References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.

Friends And Related Function Documentation

friend class VDirectory [friend, inherited]
 

Definition at line 56 of file VEntry.

friend class VFile [friend, inherited]
 

Definition at line 57 of file VEntry.

friend class VFileSystem [friend]
 

Reimplemented from base::VEntry.

Reimplemented in base::CacheFile.

Definition at line 59 of file VFile.

Member Data Documentation

int base::Referenced::_refCount [mutable, protected, inherited]
 

Definition at line 136 of file Referenced.

Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

bool base::Referenced::onUnreferenceEnabled [protected, inherited]
 

Definition at line 137 of file Referenced.

Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

PathName base::VEntry::pathname [protected, inherited]
 

Definition at line 49 of file VEntry.

Referenced by base::VEntry::name(), base::VEntry::operator=(), base::VEntry::operator==(), base::VEntry::path(), base::VEntry::pathName(), and base::VEntry::VEntry().

The documentation for this class was generated from the following file:
Generated on Thu Jul 29 16:39:36 2004 for OpenSim by doxygen 1.3.6